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