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

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