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

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