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