git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/CCS/ARM_CM3/port.c

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