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

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