git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CCS/ARM_CM3/port.c

   1 /*\r
   2  * FreeRTOS Kernel V10.2.1\r
   3  * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software.\r
  14  *\r
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  17  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  18  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  19  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  20  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  21  *\r
  22  * http://www.FreeRTOS.org\r
  23  * http://aws.amazon.com/freertos\r
  24  *\r
  25  * 1 tab == 4 spaces!\r
  26  */\r
  27 \r
  28 /*-----------------------------------------------------------\r
  29  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
  30  *----------------------------------------------------------*/\r
  31 \r
  32 /* Scheduler includes. */\r
  33 #include "FreeRTOS.h"\r
  34 #include "task.h"\r
  35 \r
  36 #if( configMAX_SYSCALL_INTERRUPT_PRIORITY == 0 )\r
  37         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
  38 #endif\r
  39 \r
  40 #ifndef configSYSTICK_CLOCK_HZ\r
  41         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
  42         /* Ensure the SysTick is clocked at the same frequency as the core. */\r
  43         #define portNVIC_SYSTICK_CLK_BIT        ( 1UL << 2UL )\r
  44 #else\r
  45         /* The way the SysTick is clocked is not modified in case it is not the same\r
  46         as the core. */\r
  47         #define portNVIC_SYSTICK_CLK_BIT        ( 0 )\r
  48 #endif\r
  49 \r
  50 /* Constants required to manipulate the core.  Registers first... */\r
  51 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile uint32_t * ) 0xe000e010 ) )\r
  52 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile uint32_t * ) 0xe000e014 ) )\r
  53 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile uint32_t * ) 0xe000e018 ) )\r
  54 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile uint32_t * ) 0xe000ed20 ) )\r
  55 /* ...then bits in the registers. */\r
  56 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
  57 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
  58 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
  59 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
  60 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
  61 \r
  62 #define portNVIC_PENDSV_PRI                                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
  63 #define portNVIC_SYSTICK_PRI                            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
  64 \r
  65 /* Constants required to check the validity of an interrupt priority. */\r
  66 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
  67 #define portNVIC_IP_REGISTERS_OFFSET_16         ( 0xE000E3F0 )\r
  68 #define portAIRCR_REG                                           ( * ( ( volatile uint32_t * ) 0xE000ED0C ) )\r
  69 #define portMAX_8_BIT_VALUE                                     ( ( uint8_t ) 0xff )\r
  70 #define portTOP_BIT_OF_BYTE                                     ( ( uint8_t ) 0x80 )\r
  71 #define portMAX_PRIGROUP_BITS                           ( ( uint8_t ) 7 )\r
  72 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
  73 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
  74 \r
  75 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
  76 #define portVECTACTIVE_MASK                                     ( 0xFFUL )\r
  77 \r
  78 /* Constants required to set up the initial stack. */\r
  79 #define portINITIAL_XPSR                                        ( 0x01000000 )\r
  80 \r
  81 /* The systick is a 24-bit counter. */\r
  82 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
  83 \r
  84 /* A fiddle factor to estimate the number of SysTick counts that would have\r
  85 occurred while the SysTick counter is stopped during tickless idle\r
  86 calculations. */\r
  87 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
  88 \r
  89 /* For strict compliance with the Cortex-M spec the task start address should\r
  90 have bit-0 clear, as it is loaded into the PC on exit from an ISR. */\r
  91 #define portSTART_ADDRESS_MASK          ( ( StackType_t ) 0xfffffffeUL )\r
  92 \r
  93 /*\r
  94  * Setup the timer to generate the tick interrupts.  The implementation in this\r
  95  * file is weak to allow application writers to change the timer used to\r
  96  * generate the tick interrupt.\r
  97  */\r
  98 void vPortSetupTimerInterrupt( void );\r
  99 \r
 100 /*\r
 101  * Exception handlers.\r
 102  */\r
 103 void xPortSysTickHandler( void );\r
 104 \r
 105 /*\r
 106  * Start first task is a separate function so it can be tested in isolation.\r
 107  */\r
 108 extern void vPortStartFirstTask( void );\r
 109 \r
 110 /*\r
 111  * Used to catch tasks that attempt to return from their implementing function.\r
 112  */\r
 113 static void prvTaskExitError( void );\r
 114 \r
 115 /*-----------------------------------------------------------*/\r
 116 \r
 117 /* Required to allow portasm.asm access the configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 118 setting. */\r
 119 const uint32_t ulMaxSyscallInterruptPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 120 \r
 121 /* Each task maintains its own interrupt status in the critical nesting\r
 122 variable. */\r
 123 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
 124 \r
 125 /*\r
 126  * The number of SysTick increments that make up one tick period.\r
 127  */\r
 128 #if( configUSE_TICKLESS_IDLE == 1 )\r
 129         static uint32_t ulTimerCountsForOneTick = 0;\r
 130 #endif /* configUSE_TICKLESS_IDLE */\r
 131 \r
 132 /*\r
 133  * The maximum number of tick periods that can be suppressed is limited by the\r
 134  * 24 bit resolution of the SysTick timer.\r
 135  */\r
 136 #if( configUSE_TICKLESS_IDLE == 1 )\r
 137         static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
 138 #endif /* configUSE_TICKLESS_IDLE */\r
 139 \r
 140 /*\r
 141  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
 142  * power functionality only.\r
 143  */\r
 144 #if( configUSE_TICKLESS_IDLE == 1 )\r
 145         static uint32_t ulStoppedTimerCompensation = 0;\r
 146 #endif /* configUSE_TICKLESS_IDLE */\r
 147 \r
 148 /*\r
 149  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
 150  * FreeRTOS API functions are not called from interrupts that have been assigned\r
 151  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 152  */\r
 153 #if ( configASSERT_DEFINED == 1 )\r
 154          static uint8_t ucMaxSysCallPriority = 0;\r
 155          static uint32_t ulMaxPRIGROUPValue = 0;\r
 156          static const volatile uint8_t * const pcInterruptPriorityRegisters = ( uint8_t * ) portNVIC_IP_REGISTERS_OFFSET_16;\r
 157 #endif /* configASSERT_DEFINED */\r
 158 \r
 159 /*-----------------------------------------------------------*/\r
 160 \r
 161 /*\r
 162  * See header file for description.\r
 163  */\r
 164 StackType_t * pxPortInitialiseStack( StackType_t * pxTopOfStack,\r
 165                                      TaskFunction_t pxCode,\r
 166                                      void * pvParameters )\r
 167 {\r
 168         /* Simulate the stack frame as it would be created by a context switch\r
 169         interrupt. */\r
 170 \r
 171         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 172         of interrupts, and to ensure alignment. */\r
 173         pxTopOfStack--;\r
 174 \r
 175         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 176         pxTopOfStack--;\r
 177         *pxTopOfStack = ( ( StackType_t ) pxCode ) & portSTART_ADDRESS_MASK;    /* PC */\r
 178         pxTopOfStack--;\r
 179         *pxTopOfStack = ( StackType_t ) prvTaskExitError;       /* LR */\r
 180 \r
 181         /* Save code space by skipping register initialisation. */\r
 182         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 183         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
 184 \r
 185         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 186 \r
 187         return pxTopOfStack;\r
 188 }\r
 189 /*-----------------------------------------------------------*/\r
 190 \r
 191 static void prvTaskExitError( void )\r
 192 {\r
 193         /* A function that implements a task must not exit or attempt to return to\r
 194         its caller as there is nothing to return to.  If a task wants to exit it\r
 195         should instead call vTaskDelete( NULL ).\r
 196 \r
 197         Artificially force an assert() to be triggered if configASSERT() is\r
 198         defined, then stop here so application writers can catch the error. */\r
 199         configASSERT( uxCriticalNesting == ~0UL );\r
 200         portDISABLE_INTERRUPTS();\r
 201         for( ;; );\r
 202 }\r
 203 /*-----------------------------------------------------------*/\r
 204 \r
 205 /*\r
 206  * See header file for description.\r
 207  */\r
 208 BaseType_t xPortStartScheduler( void )\r
 209 {\r
 210         #if( configASSERT_DEFINED == 1 )\r
 211         {\r
 212                 volatile uint32_t ulOriginalPriority;\r
 213                 volatile uint8_t * const pucFirstUserPriorityRegister = ( uint8_t * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
 214                 volatile uint8_t ucMaxPriorityValue;\r
 215 \r
 216                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
 217                 functions can be called.  ISR safe functions are those that end in\r
 218                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
 219                 ensure interrupt entry is as fast and simple as possible.\r
 220 \r
 221                 Save the interrupt priority value that is about to be clobbered. */\r
 222                 ulOriginalPriority = *pucFirstUserPriorityRegister;\r
 223 \r
 224                 /* Determine the number of priority bits available.  First write to all\r
 225                 possible bits. */\r
 226                 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
 227 \r
 228                 /* Read the value back to see how many bits stuck. */\r
 229                 ucMaxPriorityValue = *pucFirstUserPriorityRegister;\r
 230 \r
 231                 /* Use the same mask on the maximum system call priority. */\r
 232                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
 233 \r
 234                 /* Calculate the maximum acceptable priority group value for the number\r
 235                 of bits read back. */\r
 236                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
 237                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
 238                 {\r
 239                         ulMaxPRIGROUPValue--;\r
 240                         ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
 241                 }\r
 242 \r
 243                 #ifdef __NVIC_PRIO_BITS\r
 244                 {\r
 245                         /* Check the CMSIS configuration that defines the number of\r
 246                         priority bits matches the number of priority bits actually queried\r
 247                         from the hardware. */\r
 248                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
 249                 }\r
 250                 #endif\r
 251 \r
 252                 #ifdef configPRIO_BITS\r
 253                 {\r
 254                         /* Check the FreeRTOS configuration that defines the number of\r
 255                         priority bits matches the number of priority bits actually queried\r
 256                         from the hardware. */\r
 257                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
 258                 }\r
 259                 #endif\r
 260 \r
 261                 /* Shift the priority group value back to its position within the AIRCR\r
 262                 register. */\r
 263                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
 264                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
 265 \r
 266                 /* Restore the clobbered interrupt priority register to its original\r
 267                 value. */\r
 268                 *pucFirstUserPriorityRegister = ulOriginalPriority;\r
 269         }\r
 270         #endif /* conifgASSERT_DEFINED */\r
 271 \r
 272         /* Make PendSV and SysTick the lowest priority interrupts. */\r
 273         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
 274         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
 275 \r
 276         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 277         here already. */\r
 278         vPortSetupTimerInterrupt();\r
 279 \r
 280         /* Initialise the critical nesting count ready for the first task. */\r
 281         uxCriticalNesting = 0;\r
 282 \r
 283         /* Start the first task. */\r
 284         vPortStartFirstTask();\r
 285 \r
 286         /* Should not get here! */\r
 287         return 0;\r
 288 }\r
 289 /*-----------------------------------------------------------*/\r
 290 \r
 291 void vPortEndScheduler( void )\r
 292 {\r
 293         /* Not implemented in ports where there is nothing to return to.\r
 294         Artificially force an assert. */\r
 295         configASSERT( uxCriticalNesting == 1000UL );\r
 296 }\r
 297 /*-----------------------------------------------------------*/\r
 298 \r
 299 void vPortEnterCritical( void )\r
 300 {\r
 301         portDISABLE_INTERRUPTS();\r
 302         uxCriticalNesting++;\r
 303 \r
 304         /* This is not the interrupt safe version of the enter critical function so\r
 305         assert() if it is being called from an interrupt context.  Only API\r
 306         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
 307         the critical nesting count is 1 to protect against recursive calls if the\r
 308         assert function also uses a critical section. */\r
 309         if( uxCriticalNesting == 1 )\r
 310         {\r
 311                 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );\r
 312         }\r
 313 }\r
 314 /*-----------------------------------------------------------*/\r
 315 \r
 316 void vPortExitCritical( void )\r
 317 {\r
 318         configASSERT( uxCriticalNesting );\r
 319         uxCriticalNesting--;\r
 320         if( uxCriticalNesting == 0 )\r
 321         {\r
 322                 portENABLE_INTERRUPTS();\r
 323         }\r
 324 }\r
 325 /*-----------------------------------------------------------*/\r
 326 \r
 327 void xPortSysTickHandler( void )\r
 328 {\r
 329         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
 330         executes all interrupts must be unmasked.  There is therefore no need to\r
 331         save and then restore the interrupt mask value as its value is already\r
 332         known. */\r
 333         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 334         {\r
 335                 /* Increment the RTOS tick. */\r
 336                 if( xTaskIncrementTick() != pdFALSE )\r
 337                 {\r
 338                         /* A context switch is required.  Context switching is performed in\r
 339                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
 340                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 341                 }\r
 342         }\r
 343         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 344 }\r
 345 /*-----------------------------------------------------------*/\r
 346 \r
 347 #if( configUSE_TICKLESS_IDLE == 1 )\r
 348 \r
 349         #pragma WEAK( vPortSuppressTicksAndSleep )\r
 350         void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
 351         {\r
 352         uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
 353         TickType_t xModifiableIdleTime;\r
 354 \r
 355                 /* Make sure the SysTick reload value does not overflow the counter. */\r
 356                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 357                 {\r
 358                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 359                 }\r
 360 \r
 361                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
 362                 is accounted for as best it can be, but using the tickless mode will\r
 363                 inevitably result in some tiny drift of the time maintained by the\r
 364                 kernel with respect to calendar time. */\r
 365                 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;\r
 366 \r
 367                 /* Calculate the reload value required to wait xExpectedIdleTime\r
 368                 tick periods.  -1 is used because this code will execute part way\r
 369                 through one of the tick periods. */\r
 370                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
 371                 if( ulReloadValue > ulStoppedTimerCompensation )\r
 372                 {\r
 373                         ulReloadValue -= ulStoppedTimerCompensation;\r
 374                 }\r
 375 \r
 376                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
 377                 method as that will mask interrupts that should exit sleep mode. */\r
 378                 __asm( "        cpsid i" );\r
 379                 __asm( "        dsb" );\r
 380                 __asm( "        isb" );\r
 381 \r
 382 \r
 383                 /* If a context switch is pending or a task is waiting for the scheduler\r
 384                 to be unsuspended then abandon the low power entry. */\r
 385                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
 386                 {\r
 387                         /* Restart from whatever is left in the count register to complete\r
 388                         this tick period. */\r
 389                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 390 \r
 391                         /* Restart SysTick. */\r
 392                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 393 \r
 394                         /* Reset the reload register to the value required for normal tick\r
 395                         periods. */\r
 396                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
 397 \r
 398                         /* Re-enable interrupts - see comments above __disable_interrupt()\r
 399                         call above. */\r
 400                         __asm( "        cpsie i" );\r
 401                 }\r
 402                 else\r
 403                 {\r
 404                         /* Set the new reload value. */\r
 405                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
 406 \r
 407                         /* Clear the SysTick count flag and set the count value back to\r
 408                         zero. */\r
 409                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 410 \r
 411                         /* Restart SysTick. */\r
 412                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 413 \r
 414                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
 415                         set its parameter to 0 to indicate that its implementation contains\r
 416                         its own wait for interrupt or wait for event instruction, and so wfi\r
 417                         should not be executed again.  However, the original expected idle\r
 418                         time variable must remain unmodified, so a copy is taken. */\r
 419                         xModifiableIdleTime = xExpectedIdleTime;\r
 420                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
 421                         if( xModifiableIdleTime > 0 )\r
 422                         {\r
 423                                 __asm( "        dsb" );\r
 424                                 __asm( "        wfi" );\r
 425                                 __asm( "        isb" );\r
 426                         }\r
 427                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
 428 \r
 429                         /* Re-enable interrupts to allow the interrupt that brought the MCU\r
 430                         out of sleep mode to execute immediately.  see comments above\r
 431                         __disable_interrupt() call above. */\r
 432                         __asm( "        cpsie i" );\r
 433                         __asm( "        dsb" );\r
 434                         __asm( "        isb" );\r
 435 \r
 436                         /* Disable interrupts again because the clock is about to be stopped\r
 437                         and interrupts that execute while the clock is stopped will increase\r
 438                         any slippage between the time maintained by the RTOS and calendar\r
 439                         time. */\r
 440                         __asm( "        cpsid i" );\r
 441                         __asm( "        dsb" );\r
 442                         __asm( "        isb" );\r
 443 \r
 444                         /* Disable the SysTick clock without reading the\r
 445                         portNVIC_SYSTICK_CTRL_REG register to ensure the\r
 446                         portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set.  Again,\r
 447                         the time the SysTick is stopped for is accounted for as best it can\r
 448                         be, but using the tickless mode will inevitably result in some tiny\r
 449                         drift of the time maintained by the kernel with respect to calendar\r
 450                         time*/\r
 451                         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );\r
 452 \r
 453                         /* Determine if the SysTick clock has already counted to zero and\r
 454                         been set back to the current reload value (the reload back being\r
 455                         correct for the entire expected idle time) or if the SysTick is yet\r
 456                         to count to zero (in which case an interrupt other than the SysTick\r
 457                         must have brought the system out of sleep mode). */\r
 458                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
 459                         {\r
 460                                 uint32_t ulCalculatedLoadValue;\r
 461 \r
 462                                 /* The tick interrupt is already pending, and the SysTick count\r
 463                                 reloaded with ulReloadValue.  Reset the\r
 464                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
 465                                 period. */\r
 466                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
 467 \r
 468                                 /* Don't allow a tiny value, or values that have somehow\r
 469                                 underflowed because the post sleep hook did something\r
 470                                 that took too long. */\r
 471                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
 472                                 {\r
 473                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
 474                                 }\r
 475 \r
 476                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
 477 \r
 478                                 /* As the pending tick will be processed as soon as this\r
 479                                 function exits, the tick value maintained by the tick is stepped\r
 480                                 forward by one less than the time spent waiting. */\r
 481                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 482                         }\r
 483                         else\r
 484                         {\r
 485                                 /* Something other than the tick interrupt ended the sleep.\r
 486                                 Work out how long the sleep lasted rounded to complete tick\r
 487                                 periods (not the ulReload value which accounted for part\r
 488                                 ticks). */\r
 489                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 490 \r
 491                                 /* How many complete tick periods passed while the processor\r
 492                                 was waiting? */\r
 493                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
 494 \r
 495                                 /* The reload value is set to whatever fraction of a single tick\r
 496                                 period remains. */\r
 497                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
 498                         }\r
 499 \r
 500                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
 501                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
 502                         value. */\r
 503                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 504                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 505                         vTaskStepTick( ulCompleteTickPeriods );\r
 506                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
 507 \r
 508                         /* Exit with interrpts enabled. */\r
 509                         __asm( "        cpsie i" );\r
 510                 }\r
 511         }\r
 512 \r
 513 #endif /* configUSE_TICKLESS_IDLE */\r
 514 /*-----------------------------------------------------------*/\r
 515 \r
 516 /*\r
 517  * Setup the systick timer to generate the tick interrupts at the required\r
 518  * frequency.\r
 519  */\r
 520 #pragma WEAK( vPortSetupTimerInterrupt )\r
 521 void vPortSetupTimerInterrupt( void )\r
 522 {\r
 523         /* Calculate the constants required to configure the tick interrupt. */\r
 524         #if( configUSE_TICKLESS_IDLE == 1 )\r
 525         {\r
 526                 ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
 527                 xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
 528                 ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
 529         }\r
 530         #endif /* configUSE_TICKLESS_IDLE */\r
 531 \r
 532         /* Stop and clear the SysTick. */\r
 533         portNVIC_SYSTICK_CTRL_REG = 0UL;\r
 534         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 535 \r
 536         /* Configure SysTick to interrupt at the requested rate. */\r
 537         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 538         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
 539 }\r
 540 /*-----------------------------------------------------------*/\r
 541 \r
 542 #if( configASSERT_DEFINED == 1 )\r
 543 \r
 544         void vPortValidateInterruptPriority( void )\r
 545         {\r
 546         extern uint32_t ulPortGetIPSR( void );\r
 547         uint32_t ulCurrentInterrupt;\r
 548         uint8_t ucCurrentPriority;\r
 549 \r
 550                 ulCurrentInterrupt = ulPortGetIPSR();\r
 551 \r
 552                 /* Is the interrupt number a user defined interrupt? */\r
 553                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
 554                 {\r
 555                         /* Look up the interrupt's priority. */\r
 556                         ucCurrentPriority = pcInterruptPriorityRegisters[ ulCurrentInterrupt ];\r
 557 \r
 558                         /* The following assertion will fail if a service routine (ISR) for\r
 559                         an interrupt that has been assigned a priority above\r
 560                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
 561                         function.  ISR safe FreeRTOS API functions must *only* be called\r
 562                         from interrupts that have been assigned a priority at or below\r
 563                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 564 \r
 565                         Numerically low interrupt priority numbers represent logically high\r
 566                         interrupt priorities, therefore the priority of the interrupt must\r
 567                         be set to a value equal to or numerically *higher* than\r
 568                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 569 \r
 570                         Interrupts that use the FreeRTOS API must not be left at their\r
 571                         default priority of     zero as that is the highest possible priority,\r
 572                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
 573                         and     therefore also guaranteed to be invalid.\r
 574 \r
 575                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
 576                         interrupt entry is as fast and simple as possible.\r
 577 \r
 578                         The following links provide detailed information:\r
 579                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
 580                         http://www.freertos.org/FAQHelp.html */\r
 581                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
 582                 }\r
 583 \r
 584                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
 585                 that define each interrupt's priority to be split between bits that\r
 586                 define the interrupt's pre-emption priority bits and bits that define\r
 587                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
 588                 to be pre-emption priority bits.  The following assertion will fail if\r
 589                 this is not the case (if some bits represent a sub-priority).\r
 590 \r
 591                 If the application only uses CMSIS libraries for interrupt\r
 592                 configuration then the correct setting can be achieved on all Cortex-M\r
 593                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
 594                 scheduler.  Note however that some vendor specific peripheral libraries\r
 595                 assume a non-zero priority group setting, in which cases using a value\r
 596                 of zero will result in unpredictable behaviour. */\r
 597                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
 598         }\r
 599 \r
 600 #endif /* configASSERT_DEFINED */\r
 601 \r
 602 \r
 603 \r
 604 \r
 605 \r
 606 \r
 607 \r
 608 \r
 609 \r
 610 \r
 611 \r
 612 \r
 613 \r
 614 \r
 615 \r
 616 \r
 617 \r
 618 \r
 619 \r
 620 \r
 621 \r