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