begriffs open source - cmsis-freertos/blob - Source/portable/CCS/ARM_CM3/port.c

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