begriffs open source - freertos/blob - portable/IAR/ARM_CM3/port.c

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