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

   1 /*\r
   2     FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.\r
   3     All rights reserved\r
   4 \r
   5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  28     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  29     >>!   obliged to provide the source code for proprietary components     !<<\r
  30     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /*-----------------------------------------------------------\r
  67  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
  68  *----------------------------------------------------------*/\r
  69 \r
  70 /* Scheduler includes. */\r
  71 #include "FreeRTOS.h"\r
  72 #include "task.h"\r
  73 \r
  74 /* Constants required to manipulate the NVIC. */\r
  75 #define portNVIC_SYSTICK_CTRL           ( ( volatile uint32_t * ) 0xe000e010 )\r
  76 #define portNVIC_SYSTICK_LOAD           ( ( volatile uint32_t * ) 0xe000e014 )\r
  77 #define portNVIC_SYSPRI2                        ( ( volatile uint32_t * ) 0xe000ed20 )\r
  78 #define portNVIC_SYSTICK_CLK            0x00000004\r
  79 #define portNVIC_SYSTICK_INT            0x00000002\r
  80 #define portNVIC_SYSTICK_ENABLE         0x00000001\r
  81 #define portNVIC_PENDSV_PRI                     ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
  82 #define portNVIC_SYSTICK_PRI            ( ( ( uint32_t ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
  83 \r
  84 /* Masks off all bits but the VECTACTIVE bits in the ICSR register. */\r
  85 #define portVECTACTIVE_MASK                                     ( 0x1FUL )\r
  86 \r
  87 /* Constants required to manipulate the VFP. */\r
  88 #define portFPCCR                                       ( ( volatile uint32_t * ) 0xe000ef34 ) /* Floating point context control register. */\r
  89 #define portASPEN_AND_LSPEN_BITS        ( 0x3UL << 30UL )\r
  90 \r
  91 /* Constants required to set up the initial stack. */\r
  92 #define portINITIAL_XPSR                        ( 0x01000000 )\r
  93 #define portINITIAL_EXEC_RETURN         ( 0xfffffffd )\r
  94 \r
  95 /* Let the user override the pre-loading of the initial LR with the address of\r
  96 prvTaskExitError() in case is messes up unwinding of the stack in the\r
  97 debugger. */\r
  98 #ifdef configTASK_RETURN_ADDRESS\r
  99         #define portTASK_RETURN_ADDRESS configTASK_RETURN_ADDRESS\r
 100 #else\r
 101         #define portTASK_RETURN_ADDRESS prvTaskExitError\r
 102 #endif\r
 103 \r
 104 /* The priority used by the kernel is assigned to a variable to make access\r
 105 from inline assembler easier. */\r
 106 const uint32_t ulKernelPriority = configKERNEL_INTERRUPT_PRIORITY;\r
 107 \r
 108 /* Each task maintains its own interrupt status in the critical nesting\r
 109 variable. */\r
 110 static uint32_t ulCriticalNesting = 0xaaaaaaaaUL;\r
 111 \r
 112 /*\r
 113  * Setup the timer to generate the tick interrupts.\r
 114  */\r
 115 static void prvSetupTimerInterrupt( void );\r
 116 \r
 117 /*\r
 118  * Exception handlers.\r
 119  */\r
 120 void SysTick_Handler( void );\r
 121 \r
 122 /*\r
 123  * Functions defined in port_asm.asm.\r
 124  */\r
 125 extern void vPortEnableVFP( void );\r
 126 extern void vPortStartFirstTask( void );\r
 127 \r
 128 /*\r
 129  * Used to catch tasks that attempt to return from their implementing function.\r
 130  */\r
 131 static void prvTaskExitError( void );\r
 132 \r
 133 /* This exists purely to allow the const to be used from within the\r
 134 port_asm.asm assembly file. */\r
 135 const uint32_t ulMaxSyscallInterruptPriorityConst = configMAX_SYSCALL_INTERRUPT_PRIORITY;\r
 136 \r
 137 /*-----------------------------------------------------------*/\r
 138 \r
 139 /*\r
 140  * See header file for description.\r
 141  */\r
 142 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 143 {\r
 144         /* Simulate the stack frame as it would be created by a context switch\r
 145         interrupt. */\r
 146 \r
 147         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 148         of interrupts, and to ensure alignment. */\r
 149         pxTopOfStack--;\r
 150 \r
 151         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 152         pxTopOfStack--;\r
 153         *pxTopOfStack = ( StackType_t ) pxCode; /* PC */\r
 154         pxTopOfStack--;\r
 155         *pxTopOfStack = ( StackType_t ) portTASK_RETURN_ADDRESS;        /* LR */\r
 156 \r
 157         /* Save code space by skipping register initialisation. */\r
 158         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 159         *pxTopOfStack = ( StackType_t ) pvParameters;   /* R0 */\r
 160 \r
 161         /* A save method is being used that requires each task to maintain its\r
 162         own exec return value. */\r
 163         pxTopOfStack--;\r
 164         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
 165 \r
 166         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 167 \r
 168         return pxTopOfStack;\r
 169 }\r
 170 /*-----------------------------------------------------------*/\r
 171 \r
 172 static void prvTaskExitError( void )\r
 173 {\r
 174         /* A function that implements a task must not exit or attempt to return to\r
 175         its caller as there is nothing to return to.  If a task wants to exit it\r
 176         should instead call vTaskDelete( NULL ).\r
 177 \r
 178         Artificially force an assert() to be triggered if configASSERT() is\r
 179         defined, then stop here so application writers can catch the error. */\r
 180         configASSERT( ulCriticalNesting == ~0UL );\r
 181         portDISABLE_INTERRUPTS();\r
 182         for( ;; );\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 /*\r
 187  * See header file for description.\r
 188  */\r
 189 BaseType_t xPortStartScheduler( void )\r
 190 {\r
 191         /* configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.\r
 192         See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html */\r
 193         configASSERT( ( configMAX_SYSCALL_INTERRUPT_PRIORITY ) );\r
 194 \r
 195         /* Make PendSV and SysTick the lowest priority interrupts. */\r
 196         *(portNVIC_SYSPRI2) |= portNVIC_PENDSV_PRI;\r
 197         *(portNVIC_SYSPRI2) |= portNVIC_SYSTICK_PRI;\r
 198 \r
 199         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 200         here already. */\r
 201         prvSetupTimerInterrupt();\r
 202 \r
 203         /* Initialise the critical nesting count ready for the first task. */\r
 204         ulCriticalNesting = 0;\r
 205 \r
 206         /* Ensure the VFP is enabled - it should be anyway. */\r
 207         vPortEnableVFP();\r
 208 \r
 209         /* Lazy save always. */\r
 210         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
 211 \r
 212         /* Start the first task. */\r
 213         vPortStartFirstTask();\r
 214 \r
 215         /* Should not get here! */\r
 216         return 0;\r
 217 }\r
 218 /*-----------------------------------------------------------*/\r
 219 \r
 220 void vPortEndScheduler( void )\r
 221 {\r
 222         /* Not implemented in ports where there is nothing to return to.\r
 223         Artificially force an assert. */\r
 224         configASSERT( ulCriticalNesting == 1000UL );\r
 225 }\r
 226 /*-----------------------------------------------------------*/\r
 227 \r
 228 void vPortYield( void )\r
 229 {\r
 230         /* Set a PendSV to request a context switch. */\r
 231         *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;\r
 232 \r
 233         /* Barriers are normally not required but do ensure the code is completely\r
 234         within the specified behaviour for the architecture. */\r
 235         __DSB();\r
 236         __ISB();\r
 237 }\r
 238 /*-----------------------------------------------------------*/\r
 239 \r
 240 void vPortEnterCritical( void )\r
 241 {\r
 242         portDISABLE_INTERRUPTS();\r
 243         ulCriticalNesting++;\r
 244         __DSB();\r
 245         __ISB();\r
 246 \r
 247         /* This is not the interrupt safe version of the enter critical function so\r
 248         assert() if it is being called from an interrupt context.  Only API\r
 249         functions that end in "FromISR" can be used in an interrupt.  Only assert if\r
 250         the critical nesting count is 1 to protect against recursive calls if the\r
 251         assert function also uses a critical section. */\r
 252         if( ulCriticalNesting == 1 )\r
 253         {\r
 254                 configASSERT( ( ( *(portNVIC_INT_CTRL) ) & portVECTACTIVE_MASK ) == 0 );\r
 255         }\r
 256 }\r
 257 /*-----------------------------------------------------------*/\r
 258 \r
 259 void vPortExitCritical( void )\r
 260 {\r
 261         configASSERT( ulCriticalNesting );\r
 262         ulCriticalNesting--;\r
 263         if( ulCriticalNesting == 0 )\r
 264         {\r
 265                 portENABLE_INTERRUPTS();\r
 266         }\r
 267 }\r
 268 /*-----------------------------------------------------------*/\r
 269 \r
 270 void SysTick_Handler( void )\r
 271 {\r
 272 uint32_t ulDummy;\r
 273 \r
 274         ulDummy = portSET_INTERRUPT_MASK_FROM_ISR();\r
 275         {\r
 276                 if( xTaskIncrementTick() != pdFALSE )\r
 277                 {\r
 278                         /* Pend a context switch. */\r
 279                         *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;\r
 280                 }\r
 281         }\r
 282         portCLEAR_INTERRUPT_MASK_FROM_ISR( ulDummy );\r
 283 }\r
 284 /*-----------------------------------------------------------*/\r
 285 \r
 286 /*\r
 287  * Setup the systick timer to generate the tick interrupts at the required\r
 288  * frequency.\r
 289  */\r
 290 void prvSetupTimerInterrupt( void )\r
 291 {\r
 292         /* Configure SysTick to interrupt at the requested rate. */\r
 293         *(portNVIC_SYSTICK_LOAD) = ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 294         *(portNVIC_SYSTICK_CTRL) = portNVIC_SYSTICK_CLK | portNVIC_SYSTICK_INT | portNVIC_SYSTICK_ENABLE;\r
 295 }\r
 296 /*-----------------------------------------------------------*/\r
 297 \r