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

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