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