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