begriffs open source - freertos/blob - portable/MikroC/ARM_CM4F/port.c

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