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

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