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