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