begriffs open source - freertos/blob - portable/CCS/ARM_CM4F/port.c

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