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

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