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