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