begriffs open source - freertos/blob - portable/GCC/ARM_CM3/port.c

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