git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MikroC/ARM_CM4F/port.c

   1 /*\r
   2  * FreeRTOS Kernel V10.0.0\r
   3  * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
   4  *\r
   5  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
   6  * this software and associated documentation files (the "Software"), to deal in\r
   7  * the Software without restriction, including without limitation the rights to\r
   8  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
   9  * the Software, and to permit persons to whom the Software is furnished to do so,\r
  10  * subject to the following conditions:\r
  11  *\r
  12  * The above copyright notice and this permission notice shall be included in all\r
  13  * copies or substantial portions of the Software. If you wish to use our Amazon\r
  14  * FreeRTOS name, please do so in a fair use way that does not cause confusion.\r
  15  *\r
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
  18  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
  19  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
  20  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
  22  *\r
  23  * http://www.FreeRTOS.org\r
  24  * http://aws.amazon.com/freertos\r
  25  *\r
  26  * 1 tab == 4 spaces!\r
  27  */\r
  28 \r
  29 /*-----------------------------------------------------------\r
  30  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
  31  *----------------------------------------------------------*/\r
  32 \r
  33 /* Scheduler includes. */\r
  34 #include "FreeRTOS.h"\r
  35 #include "task.h"\r
  36 \r
  37 \r
  38 #ifndef configSYSTICK_CLOCK_HZ\r
  39         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
  40         /* Ensure the SysTick is clocked at the same frequency as the core. */\r
  41         #define portNVIC_SYSTICK_CLK_BIT        ( 1UL << 2UL )\r
  42 #else\r
  43         /* The way the SysTick is clocked is not modified in case it is not the same\r
  44         as the core. */\r
  45         #define portNVIC_SYSTICK_CLK_BIT        ( 0 )\r
  46 #endif\r
  47 \r
  48 /* Constants required to manipulate the core.  Registers first... */\r
  49 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile uint32_t * ) 0xe000e010 ) )\r
  50 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile uint32_t * ) 0xe000e014 ) )\r
  51 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile uint32_t * ) 0xe000e018 ) )\r
  52 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile uint32_t * ) 0xe000ed20 ) )\r
  53 /* ...then bits in the registers. */\r
  54 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
  55 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
  56 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
  57 #define portNVIC_PENDSVCLEAR_BIT                         ( 1UL << 27UL )\r
  58 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
  59 \r
  60 #define portNVIC_PENDSV_PRI                                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16UL )\r
  61 #define portNVIC_SYSTICK_PRI                            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24UL )\r
  62 \r
  63 /* Constants required to check the validity of an interrupt priority. */\r
  64 #define portFIRST_USER_INTERRUPT_NUMBER         ( 16 )\r
  65 #define portNVIC_IP_REGISTERS_OFFSET_16  ( 0xE000E3F0 )\r
  66 #define portAIRCR_REG                                           ( * ( ( volatile uint32_t * ) 0xE000ED0C ) )\r
  67 #define portMAX_8_BIT_VALUE                                     ( ( uint8_t ) 0xff )\r
  68 #define portTOP_BIT_OF_BYTE                                     ( ( uint8_t ) 0x80 )\r
  69 #define portMAX_PRIGROUP_BITS                           ( ( uint8_t ) 7 )\r
  70 #define portPRIORITY_GROUP_MASK                         ( 0x07UL << 8UL )\r
  71 #define portPRIGROUP_SHIFT                                      ( 8UL )\r
  72 \r
  73 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
  74 #define portVECTACTIVE_MASK                                     ( 0xFFUL )\r
  75 \r
  76 /* Constants required to manipulate the VFP. */\r
  77 #define portFPCCR                                                       ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */\r
  78 #define portASPEN_AND_LSPEN_BITS                        ( 0x3UL << 30UL )\r
  79 \r
  80 /* Constants required to set up the initial stack. */\r
  81 #define portINITIAL_XPSR                                        ( 0x01000000 )\r
  82 #define portINITIAL_EXC_RETURN                          ( 0xfffffffd )\r
  83 \r
  84 /* The systick is a 24-bit counter. */\r
  85 #define portMAX_24_BIT_NUMBER                           ( 0xffffffUL )\r
  86 \r
  87 /* A fiddle factor to estimate the number of SysTick counts that would have\r
  88 occurred while the SysTick counter is stopped during tickless idle\r
  89 calculations. */\r
  90 #define portMISSED_COUNTS_FACTOR                        ( 45UL )\r
  91 \r
  92 /* Let the user override the pre-loading of the initial LR with the address of\r
  93 prvTaskExitError() in case it messes up unwinding of the stack in the\r
  94 debugger. */\r
  95 #ifdef configTASK_RETURN_ADDRESS\r
  96         #define portTASK_RETURN_ADDRESS configTASK_RETURN_ADDRESS\r
  97 #else\r
  98         #define portTASK_RETURN_ADDRESS prvTaskExitError\r
  99 #endif\r
 100 \r
 101 /* Cannot find a weak linkage attribute, so the\r
 102 configOVERRIDE_DEFAULT_TICK_CONFIGURATION constant must be set to 1 if the\r
 103 application writer wants to provide their own implementation of\r
 104 vPortSetupTimerInterrupt().  Ensure configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
 105 is defined. */\r
 106 #ifndef configOVERRIDE_DEFAULT_TICK_CONFIGURATION\r
 107                 #define configOVERRIDE_DEFAULT_TICK_CONFIGURATION 0\r
 108 #endif\r
 109 \r
 110 /* Manual definition of missing asm names. */\r
 111 #define psp     9\r
 112 #define basepri 17\r
 113 #define msp             8\r
 114 #define ipsr    5\r
 115 #define control 20\r
 116 \r
 117 /* From port.c. */\r
 118 extern void *pxCurrentTCB;\r
 119 \r
 120 /* Each task maintains its own interrupt status in the critical nesting\r
 121 variable. */\r
 122 static UBaseType_t uxCriticalNesting = 0xaaaaaaaa;\r
 123 \r
 124 /*\r
 125  * Setup the timer to generate the tick interrupts.  The implementation in this\r
 126  * file is weak to allow application writers to change the timer used to\r
 127  * generate the tick interrupt.\r
 128  */\r
 129 void vPortSetupTimerInterrupt( void );\r
 130 \r
 131 /*\r
 132  * Exception handlers.\r
 133  */\r
 134 void xPortPendSVHandler( void );\r
 135 void xPortSysTickHandler( void );\r
 136 void vPortSVCHandler( void );\r
 137 \r
 138 /*\r
 139  * Start first task is a separate function so it can be tested in isolation.\r
 140  */\r
 141 static void prvPortStartFirstTask( void );\r
 142 \r
 143 /*\r
 144  * Function to enable the VFP.\r
 145  */\r
 146  static void vPortEnableVFP( void );\r
 147 \r
 148 /*\r
 149  * Used to catch tasks that attempt to return from their implementing function.\r
 150  */\r
 151 static void prvTaskExitError( void );\r
 152 \r
 153 /*-----------------------------------------------------------*/\r
 154 \r
 155 /*\r
 156  * The number of SysTick increments that make up one tick period.\r
 157  */\r
 158 #if( configUSE_TICKLESS_IDLE == 1 )\r
 159         static uint32_t ulTimerCountsForOneTick = 0;\r
 160 #endif /* configUSE_TICKLESS_IDLE */\r
 161 \r
 162 /*\r
 163  * The maximum number of tick periods that can be suppressed is limited by the\r
 164  * 24 bit resolution of the SysTick timer.\r
 165  */\r
 166 #if( configUSE_TICKLESS_IDLE == 1 )\r
 167         static uint32_t xMaximumPossibleSuppressedTicks = 0;\r
 168 #endif /* configUSE_TICKLESS_IDLE */\r
 169 \r
 170 /*\r
 171  * Compensate for the CPU cycles that pass while the SysTick is stopped (low\r
 172  * power functionality only.\r
 173  */\r
 174 #if( configUSE_TICKLESS_IDLE == 1 )\r
 175         static uint32_t ulStoppedTimerCompensation = 0;\r
 176 #endif /* configUSE_TICKLESS_IDLE */\r
 177 \r
 178 /*\r
 179  * Used by the portASSERT_IF_INTERRUPT_PRIORITY_INVALID() macro to ensure\r
 180  * FreeRTOS API functions are not called from interrupts that have been assigned\r
 181  * a priority above configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 182  */\r
 183 #if ( configASSERT_DEFINED == 1 )\r
 184          static uint8_t ucMaxSysCallPriority = 0;\r
 185          static uint32_t ulMaxPRIGROUPValue = 0;\r
 186 #endif /* configASSERT_DEFINED */\r
 187 \r
 188 /*-----------------------------------------------------------*/\r
 189 \r
 190 /*\r
 191  * See header file for description.\r
 192  */\r
 193 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 194 {\r
 195         /* Simulate the stack frame as it would be created by a context switch\r
 196         interrupt. */\r
 197 \r
 198         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 199         of interrupts, and to ensure alignment. */\r
 200         pxTopOfStack--;\r
 201 \r
 202         /* Sometimes the parameters are loaded from the stack. */\r
 203         *pxTopOfStack = ( StackType_t ) pvParameters;\r
 204         pxTopOfStack--;\r
 205 \r
 206         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 207         pxTopOfStack--;\r
 208         *pxTopOfStack = ( StackType_t ) pxCode; /* PC */\r
 209         pxTopOfStack--;\r
 210         *pxTopOfStack = ( StackType_t ) portTASK_RETURN_ADDRESS;        /* LR */\r
 211 \r
 212         /* Save code space by skipping register initialisation. */\r
 213         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 214         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
 215 \r
 216         /* A save method is being used that requires each task to maintain its\r
 217         own exec return value. */\r
 218         pxTopOfStack--;\r
 219         *pxTopOfStack = portINITIAL_EXC_RETURN;\r
 220 \r
 221         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 222 \r
 223         return pxTopOfStack;\r
 224 }\r
 225 /*-----------------------------------------------------------*/\r
 226 \r
 227 static void prvTaskExitError( void )\r
 228 {\r
 229         /* A function that implements a task must not exit or attempt to return to\r
 230         its caller as there is nothing to return to.  If a task wants to exit it\r
 231         should instead call vTaskDelete( NULL ).\r
 232 \r
 233         Artificially force an assert() to be triggered if configASSERT() is\r
 234         defined, then stop here so application writers can catch the error. */\r
 235         configASSERT( uxCriticalNesting == ~0UL );\r
 236         portDISABLE_INTERRUPTS();\r
 237         for( ;; );\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 void vPortSVCHandler( void ) iv IVT_INT_SVCall ics ICS_OFF\r
 242 {\r
 243         __asm {\r
 244                         ldr r3, =_pxCurrentTCB  /* Restore the context. */\r
 245                         ldr r1, [r3]                    /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */\r
 246                         ldr r0, [r1]                    /* The first item in pxCurrentTCB is the task top of stack. */\r
 247                         ldm r0!, (r4-r11, r14)/* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */\r
 248                         msr psp, r0                             /* Restore the task stack pointer. */\r
 249                         isb\r
 250                         mov r0, #0\r
 251                         msr basepri, r0\r
 252                         bx r14\r
 253         };\r
 254 }\r
 255 /*-----------------------------------------------------------*/\r
 256 \r
 257 static void prvPortStartFirstTask( void )\r
 258 {\r
 259         __asm {\r
 260                                 ldr r0, =0xE000ED08      /* Use the NVIC offset register to locate the stack. */\r
 261                                 ldr r0, [r0]\r
 262                                 ldr r0, [r0]\r
 263                                 msr msp, r0                      /* Set the msp back to the start of the stack. */\r
 264                                 /* Clear the bit that indicates the FPU is in use in case the FPU was used\r
 265                                 before the scheduler was started - which would otherwise result in the\r
 266                                 unnecessary leaving of space in the SVC stack for lazy saving of FPU\r
 267                                 registers. */\r
 268                                 mov r0, #0\r
 269                                 msr control, r0\r
 270                                 cpsie i                          /* Globally enable interrupts. */\r
 271                                 cpsie f\r
 272                                 dsb\r
 273                                 isb\r
 274                                 svc #0                                  /* System call to start first task. */\r
 275                                 nop\r
 276                         };\r
 277 }\r
 278 /*-----------------------------------------------------------*/\r
 279 \r
 280 /*\r
 281  * See header file for description.\r
 282  */\r
 283 BaseType_t xPortStartScheduler( void )\r
 284 {\r
 285         /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.\r
 286         See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
 287         configASSERT( configMAX_SYSCALL_INTERRUPT_PRIORITY );\r
 288 \r
 289         #if( configASSERT_DEFINED == 1 )\r
 290         {\r
 291                 volatile uint32_t ulOriginalPriority;\r
 292                 volatile uint8_t * const pucFirstUserPriorityRegister = ( volatile uint8_t * const ) ( portNVIC_IP_REGISTERS_OFFSET_16 + portFIRST_USER_INTERRUPT_NUMBER );\r
 293                 volatile uint8_t ucMaxPriorityValue;\r
 294 \r
 295                 /* Determine the maximum priority from which ISR safe FreeRTOS API\r
 296                 functions can be called.  ISR safe functions are those that end in\r
 297                 "FromISR".  FreeRTOS maintains separate thread and ISR API functions to\r
 298                 ensure interrupt entry is as fast and simple as possible.\r
 299 \r
 300                 Save the interrupt priority value that is about to be clobbered. */\r
 301                 ulOriginalPriority = *pucFirstUserPriorityRegister;\r
 302 \r
 303                 /* Determine the number of priority bits available.  First write to all\r
 304                 possible bits. */\r
 305                 *pucFirstUserPriorityRegister = portMAX_8_BIT_VALUE;\r
 306 \r
 307                 /* Read the value back to see how many bits stuck. */\r
 308                 ucMaxPriorityValue = *pucFirstUserPriorityRegister;\r
 309 \r
 310                 /* The kernel interrupt priority should be set to the lowest\r
 311                 priority. */\r
 312                 configASSERT( ucMaxPriorityValue == ( configKERNEL_INTERRUPT_PRIORITY & ucMaxPriorityValue ) );\r
 313 \r
 314                 /* Use the same mask on the maximum system call priority. */\r
 315                 ucMaxSysCallPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY & ucMaxPriorityValue;\r
 316 \r
 317                 /* Calculate the maximum acceptable priority group value for the number\r
 318                 of bits read back. */\r
 319                 ulMaxPRIGROUPValue = portMAX_PRIGROUP_BITS;\r
 320                 while( ( ucMaxPriorityValue & portTOP_BIT_OF_BYTE ) == portTOP_BIT_OF_BYTE )\r
 321                 {\r
 322                         ulMaxPRIGROUPValue--;\r
 323                         ucMaxPriorityValue <<= ( uint8_t ) 0x01;\r
 324                 }\r
 325 \r
 326                 #ifdef __NVIC_PRIO_BITS\r
 327                 {\r
 328                         /* Check the CMSIS configuration that defines the number of\r
 329                         priority bits matches the number of priority bits actually queried\r
 330                         from the hardware. */\r
 331                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == __NVIC_PRIO_BITS );\r
 332                 }\r
 333                 #endif\r
 334 \r
 335                 #ifdef configPRIO_BITS\r
 336                 {\r
 337                         /* Check the FreeRTOS configuration that defines the number of\r
 338                         priority bits matches the number of priority bits actually queried\r
 339                         from the hardware. */\r
 340                         configASSERT( ( portMAX_PRIGROUP_BITS - ulMaxPRIGROUPValue ) == configPRIO_BITS );\r
 341                 }\r
 342                 #endif\r
 343 \r
 344                 /* Shift the priority group value back to its position within the AIRCR\r
 345                 register. */\r
 346                 ulMaxPRIGROUPValue <<= portPRIGROUP_SHIFT;\r
 347                 ulMaxPRIGROUPValue &= portPRIORITY_GROUP_MASK;\r
 348 \r
 349                 /* Restore the clobbered interrupt priority register to its original\r
 350                 value. */\r
 351                 *pucFirstUserPriorityRegister = ulOriginalPriority;\r
 352         }\r
 353         #endif /* conifgASSERT_DEFINED */\r
 354 \r
 355         /* Make PendSV and SysTick the lowest priority interrupts. */\r
 356         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
 357         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
 358 \r
 359         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 360         here already. */\r
 361         vPortSetupTimerInterrupt();\r
 362 \r
 363         /* Initialise the critical nesting count ready for the first task. */\r
 364         uxCriticalNesting = 0;\r
 365 \r
 366         /* Ensure the VFP is enabled - it should be anyway. */\r
 367         vPortEnableVFP();\r
 368 \r
 369         /* Lazy save always. */\r
 370         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
 371 \r
 372         /* Start the first task. */\r
 373         prvPortStartFirstTask();\r
 374 \r
 375         /* Should never get here as the tasks will now be executing!  Call the task\r
 376         exit error function to prevent compiler warnings about a static function\r
 377         not being called in the case that the application writer overrides this\r
 378         functionality by defining configTASK_RETURN_ADDRESS. */\r
 379         prvTaskExitError();\r
 380 \r
 381         /* Should not get here! */\r
 382         return 0;\r
 383 }\r
 384 /*-----------------------------------------------------------*/\r
 385 \r
 386 void vPortEndScheduler( void )\r
 387 {\r
 388         /* Not implemented in ports where there is nothing to return to.\r
 389         Artificially force an assert. */\r
 390         configASSERT( uxCriticalNesting == 1000UL );\r
 391 }\r
 392 /*-----------------------------------------------------------*/\r
 393 \r
 394 void vPortEnterCritical( void )\r
 395 {\r
 396         portDISABLE_INTERRUPTS();\r
 397         uxCriticalNesting++;\r
 398 \r
 399         /* This is not the interrupt safe version of the enter critical function so\r
 400         assert() if it is being called from an interrupt context.  Only API\r
 401         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
 402         the critical nesting count is 1 to protect against recursive calls if the\r
 403         assert function also uses a critical section. */\r
 404         if( uxCriticalNesting == 1 )\r
 405         {\r
 406                 configASSERT( ( portNVIC_INT_CTRL_REG & portVECTACTIVE_MASK ) == 0 );\r
 407         }\r
 408 }\r
 409 /*-----------------------------------------------------------*/\r
 410 \r
 411 void vPortExitCritical( void )\r
 412 {\r
 413         configASSERT( uxCriticalNesting );\r
 414         uxCriticalNesting--;\r
 415         if( uxCriticalNesting == 0 )\r
 416         {\r
 417                 portENABLE_INTERRUPTS();\r
 418         }\r
 419 }\r
 420 /*-----------------------------------------------------------*/\r
 421 \r
 422 const uint8_t ucMaxSyscallInterruptPriority = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 423 void xPortPendSVHandler( void ) iv IVT_INT_PendSV ics ICS_OFF\r
 424 {\r
 425         __asm {\r
 426 #ifdef HW_DEBUG\r
 427                                 /* The function is not truly naked, so add back the 4 bytes subtracted\r
 428                                 from the stack pointer by the function prologue. */\r
 429                 add sp, sp, #4\r
 430 #endif\r
 431         mrs r0, psp\r
 432         isb\r
 433 \r
 434         ldr     r3, =_pxCurrentTCB               /* Get the location of the current TCB. */\r
 435         ldr     r2, [r3]\r
 436 \r
 437         tst r14, #0x10                   /* Is the task using the FPU context?  If so, push high vfp registers. */\r
 438         it eq\r
 439         vstmdbeq r0!, (s16-s31)\r
 440 \r
 441         stmdb r0!, (r4-r11, r14)                 /* Save the core registers. */\r
 442 \r
 443         str r0, [r2]                     /* Save the new top of stack into the first member of the TCB. */\r
 444 \r
 445         stmdb sp!, (r0, r3)\r
 446         ldr r0, =_ucMaxSyscallInterruptPriority\r
 447         ldr r1, [r0]\r
 448         msr basepri, r1\r
 449         dsb\r
 450         isb\r
 451         bl _vTaskSwitchContext\r
 452         mov r0, #0\r
 453         msr basepri, r0\r
 454         ldm sp!, (r0, r3)\r
 455 \r
 456         ldr r1, [r3]                     /* The first item in pxCurrentTCB is the task top of stack. */\r
 457         ldr r0, [r1]\r
 458 \r
 459         ldm r0!, (r4-r11, r14)           /* Pop the core registers. */\r
 460 \r
 461         tst r14, #0x10                   /* Is the task using the FPU context?  If so, pop the high vfp registers too. */\r
 462         it eq\r
 463         vldmiaeq r0!, (s16-s31)\r
 464 \r
 465         msr psp, r0\r
 466         isb\r
 467         bx r14\r
 468         }\r
 469 }\r
 470 /*-----------------------------------------------------------*/\r
 471 \r
 472 void xPortSysTickHandler( void ) iv IVT_INT_SysTick ics ICS_AUTO\r
 473 {\r
 474         /* The SysTick runs at the lowest interrupt priority, so when this interrupt\r
 475         executes all interrupts must be unmasked.  There is therefore no need to\r
 476         save and then restore the interrupt mask value as its value is already\r
 477         known - therefore the slightly faster portDISABLE_INTERRUPTS() function is\r
 478         used in place of portSET_INTERRUPT_MASK_FROM_ISR(). */\r
 479         portDISABLE_INTERRUPTS();\r
 480         {\r
 481                 /* Increment the RTOS tick. */\r
 482                 if( xTaskIncrementTick() != pdFALSE )\r
 483                 {\r
 484                         /* A context switch is required.  Context switching is performed in\r
 485                         the PendSV interrupt.  Pend the PendSV interrupt. */\r
 486                         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 487                 }\r
 488         }\r
 489         portENABLE_INTERRUPTS();\r
 490 }\r
 491 /*-----------------------------------------------------------*/\r
 492 \r
 493 #if( ( configUSE_TICKLESS_IDLE == 1 ) && ( configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0 ) )\r
 494 \r
 495         void vPortSuppressTicksAndSleep( TickType_t xExpectedIdleTime )\r
 496         {\r
 497         uint32_t ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickDecrements;\r
 498         TickType_t xModifiableIdleTime;\r
 499 \r
 500                 /* Make sure the SysTick reload value does not overflow the counter. */\r
 501                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 502                 {\r
 503                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 504                 }\r
 505 \r
 506                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
 507                 is accounted for as best it can be, but using the tickless mode will\r
 508                 inevitably result in some tiny drift of the time maintained by the\r
 509                 kernel with respect to calendar time. */\r
 510                 portNVIC_SYSTICK_CTRL_REG &= ~portNVIC_SYSTICK_ENABLE_BIT;\r
 511 \r
 512                 /* Calculate the reload value required to wait xExpectedIdleTime\r
 513                 tick periods.  -1 is used because this code will execute part way\r
 514                 through one of the tick periods. */\r
 515                 ulReloadValue = portNVIC_SYSTICK_CURRENT_VALUE_REG + ( ulTimerCountsForOneTick * ( xExpectedIdleTime - 1UL ) );\r
 516                 if( ulReloadValue > ulStoppedTimerCompensation )\r
 517                 {\r
 518                         ulReloadValue -= ulStoppedTimerCompensation;\r
 519                 }\r
 520 \r
 521                 /* Enter a critical section but don't use the taskENTER_CRITICAL()\r
 522                 method as that will mask interrupts that should exit sleep mode. */\r
 523                 __asm { "cpsid i" };\r
 524                 __asm { "dsb" };\r
 525                 __asm { "isb" };\r
 526 \r
 527                 /* If a context switch is pending or a task is waiting for the scheduler\r
 528                 to be unsuspended then abandon the low power entry. */\r
 529                 if( eTaskConfirmSleepModeStatus() == eAbortSleep )\r
 530                 {\r
 531                         /* Restart from whatever is left in the count register to complete\r
 532                         this tick period. */\r
 533                         portNVIC_SYSTICK_LOAD_REG = portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 534 \r
 535                         /* Restart SysTick. */\r
 536                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 537 \r
 538                         /* Reset the reload register to the value required for normal tick\r
 539                         periods. */\r
 540                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
 541 \r
 542                         /* Re-enable interrupts - see comments above the cpsid instruction()\r
 543                         above. */\r
 544                         __asm { "cpsie i" };\r
 545                 }\r
 546                 else\r
 547                 {\r
 548                         /* Set the new reload value. */\r
 549                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
 550 \r
 551                         /* Clear the SysTick count flag and set the count value back to\r
 552                         zero. */\r
 553                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 554 \r
 555                         /* Restart SysTick. */\r
 556                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 557 \r
 558                         /* Sleep until something happens.  configPRE_SLEEP_PROCESSING() can\r
 559                         set its parameter to 0 to indicate that its implementation contains\r
 560                         its own wait for interrupt or wait for event instruction, and so wfi\r
 561                         should not be executed again.  However, the original expected idle\r
 562                         time variable must remain unmodified, so a copy is taken. */\r
 563                         xModifiableIdleTime = xExpectedIdleTime;\r
 564                         configPRE_SLEEP_PROCESSING( xModifiableIdleTime );\r
 565                         if( xModifiableIdleTime > 0 )\r
 566                         {\r
 567                                 __asm { "dsb" };\r
 568                                 __asm { "wfi" };\r
 569                                 __asm { "isb" };\r
 570                         }\r
 571                         configPOST_SLEEP_PROCESSING( xExpectedIdleTime );\r
 572 \r
 573                         /* Re-enable interrupts to allow the interrupt that brought the MCU\r
 574                         out of sleep mode to execute immediately.  see comments above\r
 575                         __disable_interrupt() call above. */\r
 576                         __asm { "cpsie i" };\r
 577                         __asm { "dsb" };\r
 578                         __asm { "isb" };\r
 579 \r
 580                         /* Disable interrupts again because the clock is about to be stopped\r
 581                         and interrupts that execute while the clock is stopped will increase\r
 582                         any slippage between the time maintained by the RTOS and calendar\r
 583                         time. */\r
 584                         __asm { "cpsid i" };\r
 585                         __asm { "dsb" };\r
 586                         __asm { "isb" };\r
 587 \r
 588                         /* Disable the SysTick clock without reading the\r
 589                         portNVIC_SYSTICK_CTRL_REG register to ensure the\r
 590                         portNVIC_SYSTICK_COUNT_FLAG_BIT is not cleared if it is set.  Again,\r
 591                         the time the SysTick is stopped for is accounted for as best it can\r
 592                         be, but using the tickless mode will inevitably result in some tiny\r
 593                         drift of the time maintained by the kernel with respect to calendar\r
 594                         time*/\r
 595                         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT );\r
 596 \r
 597                         /* Determine if the SysTick clock has already counted to zero and\r
 598                         been set back to the current reload value (the reload back being\r
 599                         correct for the entire expected idle time) or if the SysTick is yet\r
 600                         to count to zero (in which case an interrupt other than the SysTick\r
 601                         must have brought the system out of sleep mode). */\r
 602                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
 603                         {\r
 604                                 uint32_t ulCalculatedLoadValue;\r
 605 \r
 606                                 /* The tick interrupt is already pending, and the SysTick count\r
 607                                 reloaded with ulReloadValue.  Reset the\r
 608                                 portNVIC_SYSTICK_LOAD_REG with whatever remains of this tick\r
 609                                 period. */\r
 610                                 ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL ) - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
 611 \r
 612                                 /* Don't allow a tiny value, or values that have somehow\r
 613                                 underflowed because the post sleep hook did something\r
 614                                 that took too long. */\r
 615                                 if( ( ulCalculatedLoadValue < ulStoppedTimerCompensation ) || ( ulCalculatedLoadValue > ulTimerCountsForOneTick ) )\r
 616                                 {\r
 617                                         ulCalculatedLoadValue = ( ulTimerCountsForOneTick - 1UL );\r
 618                                 }\r
 619 \r
 620                                 portNVIC_SYSTICK_LOAD_REG = ulCalculatedLoadValue;\r
 621 \r
 622                                 /* As the pending tick will be processed as soon as this\r
 623                                 function exits, the tick value maintained by the tick is stepped\r
 624                                 forward by one less than the time spent waiting. */\r
 625                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 626                         }\r
 627                         else\r
 628                         {\r
 629                                 /* Something other than the tick interrupt ended the sleep.\r
 630                                 Work out how long the sleep lasted rounded to complete tick\r
 631                                 periods (not the ulReload value which accounted for part\r
 632                                 ticks). */\r
 633                                 ulCompletedSysTickDecrements = ( xExpectedIdleTime * ulTimerCountsForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 634 \r
 635                                 /* How many complete tick periods passed while the processor\r
 636                                 was waiting? */\r
 637                                 ulCompleteTickPeriods = ulCompletedSysTickDecrements / ulTimerCountsForOneTick;\r
 638 \r
 639                                 /* The reload value is set to whatever fraction of a single tick\r
 640                                 period remains. */\r
 641                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1UL ) * ulTimerCountsForOneTick ) - ulCompletedSysTickDecrements;\r
 642                         }\r
 643 \r
 644                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
 645                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
 646                         value. */\r
 647                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 648                         portNVIC_SYSTICK_CTRL_REG |= portNVIC_SYSTICK_ENABLE_BIT;\r
 649                         vTaskStepTick( ulCompleteTickPeriods );\r
 650                         portNVIC_SYSTICK_LOAD_REG = ulTimerCountsForOneTick - 1UL;\r
 651 \r
 652                         /* Exit with interrpts enabled. */\r
 653                         __asm { "cpsie i" };\r
 654                 }\r
 655         }\r
 656 \r
 657 #endif /* #if configUSE_TICKLESS_IDLE */\r
 658 /*-----------------------------------------------------------*/\r
 659 \r
 660 /*\r
 661  * Setup the systick timer to generate the tick interrupts at the required\r
 662  * frequency.\r
 663  */\r
 664 #if( configOVERRIDE_DEFAULT_TICK_CONFIGURATION == 0 )\r
 665 \r
 666         void vPortSetupTimerInterrupt( void )\r
 667         {\r
 668                         /* Calculate the constants required to configure the tick interrupt. */\r
 669                         #if( configUSE_TICKLESS_IDLE == 1 )\r
 670                         {\r
 671                                         ulTimerCountsForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ );\r
 672                                         xMaximumPossibleSuppressedTicks = portMAX_24_BIT_NUMBER / ulTimerCountsForOneTick;\r
 673                                         ulStoppedTimerCompensation = portMISSED_COUNTS_FACTOR / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
 674                         }\r
 675                         #endif /* configUSE_TICKLESS_IDLE */\r
 676 \r
 677                         /* Reset SysTick. */\r
 678                         portNVIC_SYSTICK_CTRL_REG = 0UL;\r
 679                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 680 \r
 681                         /* Configure SysTick to interrupt at the requested rate. */\r
 682                         portNVIC_SYSTICK_LOAD_REG = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 683                         portNVIC_SYSTICK_CTRL_REG = ( portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT );\r
 684         }\r
 685 \r
 686 #endif /* configOVERRIDE_DEFAULT_TICK_CONFIGURATION */\r
 687 /*-----------------------------------------------------------*/\r
 688 \r
 689 /* This is a naked function. */\r
 690 static void vPortEnableVFP( void )\r
 691 {\r
 692         __asm {\r
 693                         ldr r0, =0xE000ED88                      /* The FPU enable bits are in the CPACR. */\r
 694                         ldr r1, [r0]\r
 695 \r
 696                         orr r1, r1, #0xF00000            /* Enable CP10 and CP11 coprocessors, then save back. */\r
 697                         str r1, [r0]\r
 698                         bx r14\r
 699         };\r
 700 }\r
 701 /*-----------------------------------------------------------*/\r
 702 \r
 703 BaseType_t xPortIsInsideInterrupt( void )\r
 704 {\r
 705 BaseType_t xReturn;\r
 706 \r
 707         /* Obtain the number of the currently executing interrupt. */\r
 708         if( CPU_REG_GET( CPU_IPSR ) == 0 )\r
 709         {\r
 710                 xReturn = pdFALSE;\r
 711         }\r
 712         else\r
 713         {\r
 714                 xReturn = pdTRUE;\r
 715         }\r
 716 \r
 717         return xReturn;\r
 718 }\r
 719 /*-----------------------------------------------------------*/\r
 720 \r
 721 #if( configASSERT_DEFINED == 1 )\r
 722 \r
 723         /* Limitations in the MikroC inline asm means ulCurrentInterrupt has to be\r
 724         global - which makes vPortValidateInterruptPriority() non re-entrant.\r
 725         However that should not matter as an interrupt can only itself be\r
 726         interrupted by a higher priority interrupt.  That means if\r
 727         ulCurrentInterrupt, so ulCurrentInterrupt getting corrupted cannot lead to\r
 728         an invalid interrupt priority being missed. */\r
 729         uint32_t ulCurrentInterrupt;\r
 730         uint8_t ucCurrentPriority;\r
 731         void vPortValidateInterruptPriority( void )\r
 732         {\r
 733                 /* Obtain the number of the currently executing interrupt. */\r
 734                 __asm { push (r0, r1)\r
 735                                 mrs r0, ipsr\r
 736                                 ldr r1, =_ulCurrentInterrupt\r
 737                                 str r0, [r1]\r
 738                                 pop (r0, r1)\r
 739                 };\r
 740 \r
 741                 /* Is the interrupt number a user defined interrupt? */\r
 742                 if( ulCurrentInterrupt >= portFIRST_USER_INTERRUPT_NUMBER )\r
 743                 {\r
 744                         /* Look up the interrupt's priority. */\r
 745                         ucCurrentPriority = *( ( uint8_t * ) ( portNVIC_IP_REGISTERS_OFFSET_16 + ulCurrentInterrupt ) );\r
 746 \r
 747                         /* The following assertion will fail if a service routine (ISR) for\r
 748                         an interrupt that has been assigned a priority above\r
 749                         configMAX_SYSCALL_INTERRUPT_PRIORITY calls an ISR safe FreeRTOS API\r
 750                         function.  ISR safe FreeRTOS API functions must *only* be called\r
 751                         from interrupts that have been assigned a priority at or below\r
 752                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 753 \r
 754                         Numerically low interrupt priority numbers represent logically high\r
 755                         interrupt priorities, therefore the priority of the interrupt must\r
 756                         be set to a value equal to or numerically *higher* than\r
 757                         configMAX_SYSCALL_INTERRUPT_PRIORITY.\r
 758 \r
 759                         Interrupts that use the FreeRTOS API must not be left at their\r
 760                         default priority of     zero as that is the highest possible priority,\r
 761                         which is guaranteed to be above configMAX_SYSCALL_INTERRUPT_PRIORITY,\r
 762                         and     therefore also guaranteed to be invalid.\r
 763 \r
 764                         FreeRTOS maintains separate thread and ISR API functions to ensure\r
 765                         interrupt entry is as fast and simple as possible.\r
 766 \r
 767                         The following links provide detailed information:\r
 768                         http://www.freertos.org/RTOS-Cortex-M3-M4.html\r
 769                         http://www.freertos.org/FAQHelp.html */\r
 770                         configASSERT( ucCurrentPriority >= ucMaxSysCallPriority );\r
 771                 }\r
 772 \r
 773                 /* Priority grouping:  The interrupt controller (NVIC) allows the bits\r
 774                 that define each interrupt's priority to be split between bits that\r
 775                 define the interrupt's pre-emption priority bits and bits that define\r
 776                 the interrupt's sub-priority.  For simplicity all bits must be defined\r
 777                 to be pre-emption priority bits.  The following assertion will fail if\r
 778                 this is not the case (if some bits represent a sub-priority).\r
 779 \r
 780                 If the application only uses CMSIS libraries for interrupt\r
 781                 configuration then the correct setting can be achieved on all Cortex-M\r
 782                 devices by calling NVIC_SetPriorityGrouping( 0 ); before starting the\r
 783                 scheduler.  Note however that some vendor specific peripheral libraries\r
 784                 assume a non-zero priority group setting, in which cases using a value\r
 785                 of zero will result in unpredictable behaviour. */\r
 786                 configASSERT( ( portAIRCR_REG & portPRIORITY_GROUP_MASK ) <= ulMaxPRIGROUPValue );\r
 787         }\r
 788 \r
 789 #endif /* configASSERT_DEFINED */