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 /* Compiler includes. */\r
  74 #include <intrinsics.h>\r
  75 \r
  76 /* Scheduler includes. */\r
  77 #include "FreeRTOS.h"\r
  78 #include "task.h"\r
  79 \r
  80 #ifndef __ARMVFP__\r
  81         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
  82 #endif\r
  83 \r
  84 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
  85         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
  86 #endif\r
  87 \r
  88 #ifndef configSYSTICK_CLOCK_HZ\r
  89         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
  90 #endif\r
  91 \r
  92 /* Constants required to manipulate the core.  Registers first... */\r
  93 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
  94 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
  95 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
  96 #define portNVIC_INT_CTRL_REG                           ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )\r
  97 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
  98 /* ...then bits in the registers. */\r
  99 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
 100 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
 101 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
 102 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
 103 #define portNVIC_PENDSVSET_BIT                          ( 1UL << 28UL )\r
 104 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
 105 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
 106 \r
 107 #define portNVIC_PENDSV_PRI                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
 108 #define portNVIC_SYSTICK_PRI            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
 109 \r
 110 /* Constants required to manipulate the VFP. */\r
 111 #define portFPCCR                                       ( ( volatile unsigned long * ) 0xe000ef34 ) /* Floating point context control register. */\r
 112 #define portASPEN_AND_LSPEN_BITS        ( 0x3UL << 30UL )\r
 113 \r
 114 /* Constants required to set up the initial stack. */\r
 115 #define portINITIAL_XPSR                        ( 0x01000000 )\r
 116 #define portINITIAL_EXEC_RETURN         ( 0xfffffffd )\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.  The implementation in this\r
 124  * file is weak to allow application writers to change the timer used to\r
 125  * generate the tick interrupt.\r
 126  */\r
 127 void vPortSetupTimerInterrupt( void );\r
 128 \r
 129 /*\r
 130  * Exception handlers.\r
 131  */\r
 132 void xPortSysTickHandler( 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 extern void vPortStartFirstTask( void );\r
 138 \r
 139 /*\r
 140  * Turn the VFP on.\r
 141  */\r
 142 extern void vPortEnableVFP( void );\r
 143 \r
 144 /*-----------------------------------------------------------*/\r
 145 \r
 146 /*\r
 147  * The number of SysTick increments that make up one tick period.\r
 148  */\r
 149 #if configUSE_TICKLESS_IDLE == 1\r
 150         static unsigned long ulTimerReloadValueForOneTick = 0;\r
 151 #endif\r
 152 \r
 153 /*\r
 154  * The maximum number of tick periods that can be suppressed is limited by the\r
 155  * 24 bit resolution of the SysTick timer.\r
 156  */\r
 157 #if configUSE_TICKLESS_IDLE == 1\r
 158         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
 159 #endif /* configUSE_TICKLESS_IDLE */\r
 160 \r
 161 /*\r
 162  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
 163  * power functionality only.\r
 164  */\r
 165 #if configUSE_TICKLESS_IDLE == 1\r
 166         static unsigned long ulStoppedTimerCompensation = 0;\r
 167 #endif /* configUSE_TICKLESS_IDLE */\r
 168 \r
 169 /*-----------------------------------------------------------*/\r
 170 \r
 171 /*\r
 172  * See header file for description.\r
 173  */\r
 174 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 175 {\r
 176         /* Simulate the stack frame as it would be created by a context switch\r
 177         interrupt. */\r
 178 \r
 179         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 180         of interrupts, and to ensure alignment. */\r
 181         pxTopOfStack--;\r
 182 \r
 183         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 184         pxTopOfStack--;\r
 185         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 186         pxTopOfStack--;\r
 187         *pxTopOfStack = 0;      /* LR */\r
 188 \r
 189         /* Save code space by skipping register initialisation. */\r
 190         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 191         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 192 \r
 193         /* A save method is being used that requires each task to maintain its\r
 194         own exec return value. */\r
 195         pxTopOfStack--;\r
 196         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
 197 \r
 198         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 199 \r
 200         return pxTopOfStack;\r
 201 }\r
 202 /*-----------------------------------------------------------*/\r
 203 \r
 204 /*\r
 205  * See header file for description.\r
 206  */\r
 207 portBASE_TYPE xPortStartScheduler( void )\r
 208 {\r
 209         /* Make PendSV and SysTick the lowest priority interrupts. */\r
 210         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
 211         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
 212 \r
 213         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 214         here already. */\r
 215         vPortSetupTimerInterrupt();\r
 216 \r
 217         /* Initialise the critical nesting count ready for the first task. */\r
 218         uxCriticalNesting = 0;\r
 219 \r
 220         /* Ensure the VFP is enabled - it should be anyway. */\r
 221         vPortEnableVFP();\r
 222 \r
 223         /* Lazy save always. */\r
 224         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
 225 \r
 226         /* Start the first task. */\r
 227         vPortStartFirstTask();\r
 228 \r
 229         /* Should not get here! */\r
 230         return 0;\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 void vPortEndScheduler( void )\r
 235 {\r
 236         /* It is unlikely that the CM4F port will require this function as there\r
 237         is nothing to return to.  */\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 void vPortYieldFromISR( void )\r
 242 {\r
 243         /* Set a PendSV to request a context switch. */\r
 244         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 245 }\r
 246 /*-----------------------------------------------------------*/\r
 247 \r
 248 void vPortEnterCritical( void )\r
 249 {\r
 250         portDISABLE_INTERRUPTS();\r
 251         uxCriticalNesting++;\r
 252 }\r
 253 /*-----------------------------------------------------------*/\r
 254 \r
 255 void vPortExitCritical( void )\r
 256 {\r
 257         uxCriticalNesting--;\r
 258         if( uxCriticalNesting == 0 )\r
 259         {\r
 260                 portENABLE_INTERRUPTS();\r
 261         }\r
 262 }\r
 263 /*-----------------------------------------------------------*/\r
 264 \r
 265 void xPortSysTickHandler( void )\r
 266 {\r
 267         /* If using preemption, also force a context switch. */\r
 268         #if configUSE_PREEMPTION == 1\r
 269                 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 270         #endif\r
 271 \r
 272         /* Only reset the systick load register if configUSE_TICKLESS_IDLE is set to\r
 273         1.  If it is set to 0 tickless idle is not being used.  If it is set to a\r
 274         value other than 0 or 1 then a timer other than the SysTick is being used\r
 275         to generate the tick interrupt. */\r
 276         #if configUSE_TICKLESS_IDLE == 1\r
 277                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;\r
 278         #endif\r
 279 \r
 280         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 281         {\r
 282                 vTaskIncrementTick();\r
 283         }\r
 284         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 285 }\r
 286 /*-----------------------------------------------------------*/\r
 287 \r
 288 #if configUSE_TICKLESS_IDLE == 1\r
 289 \r
 290         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
 291         {\r
 292         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;\r
 293         portTickType xModifiableIdleTime;\r
 294 \r
 295                 /* Make sure the SysTick reload value does not overflow the counter. */\r
 296                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 297                 {\r
 298                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 299                 }\r
 300 \r
 301                 /* Calculate the reload value required to wait xExpectedIdleTime\r
 302                 tick periods.  -1 is used because this code will execute part way\r
 303                 through one of the tick periods, and the fraction of a tick period is\r
 304                 accounted for later. */\r
 305                 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );\r
 306                 if( ulReloadValue > ulStoppedTimerCompensation )\r
 307                 {\r
 308                         ulReloadValue -= ulStoppedTimerCompensation;\r
 309                 }\r
 310 \r
 311                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
 312                 is accounted for as best it can be, but using the tickless mode will\r
 313                 inevitably result in some tiny drift of the time maintained by the\r
 314                 kernel with respect to calendar time. */\r
 315                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 316 \r
 317                 /* Adjust the reload value to take into account that the current\r
 318                 time slice is already partially complete. */\r
 319                 ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );\r
 320 \r
 321                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
 322                 method as that will mask interrupts that should exit sleep mode. */\r
 323                 __disable_interrupt();\r
 324 \r
 325                 /* If a context switch is pending or a task is waiting for the scheduler\r
 326                 to be unsuspended then abandon the low power entry. */\r
 327                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
 328                 {\r
 329                         /* Restart SysTick. */\r
 330                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 331 \r
 332                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
 333                         call above. */\r
 334                         __enable_interrupt();\r
 335                 }\r
 336                 else\r
 337                 {\r
 338                         /* Set the new reload value. */\r
 339                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
 340 \r
 341                         /* Clear the SysTick count flag and set the count value back to\r
 342                         zero. */\r
 343                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 344 \r
 345                         /* Restart SysTick. */\r
 346                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 347 \r
 348                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
 349                         set its parameter to 0 to indicate that its implementation contains\r
 350                         its own wait for interrupt or wait for event instruction, and so wfi\r
 351                         should not be executed again.  However, the original expected idle\r
 352                         time variable must remain unmodified, so a copy is taken. */\r
 353                         xModifiableIdleTime = xExpectedIdleTime;\r
 354                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
 355                         if( xModifiableIdleTime > 0 )\r
 356                         {\r
 357                                 __WFI();\r
 358                         }\r
 359                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
 360 \r
 361                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
 362                         accounted for as best it can be, but using the tickless mode will\r
 363                         inevitably result in some tiny drift of the time maintained by the\r
 364                         kernel with respect to calendar time. */\r
 365                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 366 \r
 367                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
 368                         call above. */\r
 369                         __enable_interrupt();\r
 370 \r
 371                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
 372                         {\r
 373                                 /* The tick interrupt has already executed, and the SysTick\r
 374                                 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.\r
 375                                 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of\r
 376                                 this tick period. */\r
 377                                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
 378 \r
 379                                 /* The tick interrupt handler will already have pended the tick\r
 380                                 processing in the kernel.  As the pending tick will be\r
 381                                 processed as soon as this function exits, the tick value\r
 382                                 maintained by the tick is stepped forward by one less than the\r
 383                                 time spent waiting. */\r
 384                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 385                         }\r
 386                         else\r
 387                         {\r
 388                                 /* Something other than the tick interrupt ended the sleep.\r
 389                                 Work out how long the sleep lasted. */\r
 390                                 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 391 \r
 392                                 /* How many complete tick periods passed while the processor\r
 393                                 was waiting? */\r
 394                                 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;\r
 395 \r
 396                                 /* The reload value is set to whatever fraction of a single tick\r
 397                                 period remains. */\r
 398                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;\r
 399                         }\r
 400 \r
 401                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
 402                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
 403                         value. */\r
 404                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 405                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 406 \r
 407                         vTaskStepTick( ulCompleteTickPeriods );\r
 408                 }\r
 409         }\r
 410 \r
 411 #endif /* #if configUSE_TICKLESS_IDLE */\r
 412 /*-----------------------------------------------------------*/\r
 413 \r
 414 /*\r
 415  * Setup the systick timer to generate the tick interrupts at the required\r
 416  * frequency.\r
 417  */\r
 418 __weak void vPortSetupTimerInterrupt( void )\r
 419 {\r
 420         /* Calculate the constants required to configure the tick interrupt. */\r
 421         #if configUSE_TICKLESS_IDLE == 1\r
 422         {\r
 423                 ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 424                 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );\r
 425                 ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
 426         }\r
 427         #endif /* configUSE_TICKLESS_IDLE */\r
 428 \r
 429         /* Configure SysTick to interrupt at the requested rate. */\r
 430         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;;\r
 431         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 432 }\r
 433 /*-----------------------------------------------------------*/\r
 434 \r