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

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