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

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