git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MPLAB/PIC32MEC14xx/port.c

   1 /*\r
   2     FreeRTOS V9.0.0rc1 - Copyright (C) 2016 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 PIC32MEC14xx  port.\r
  72  *----------------------------------------------------------*/\r
  73 \r
  74 /* Scheduler include files. */\r
  75 #include "FreeRTOS.h"\r
  76 #include "task.h"\r
  77 \r
  78 /* Microchip includes. */\r
  79 #include <xc.h>\r
  80 #include <cp0defs.h>\r
  81 \r
  82 #if !defined(__MEC__)\r
  83         #error This port is designed to work with XC32 on MEC14xx.  Please update your C compiler version or settings.\r
  84 #endif\r
  85 \r
  86 #if( ( configMAX_SYSCALL_INTERRUPT_PRIORITY >= 0x7 ) || ( configMAX_SYSCALL_INTERRUPT_PRIORITY == 0 ) )\r
  87         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must be less than 7 and greater than 0\r
  88 #endif\r
  89 \r
  90 /* Bits within various registers. */\r
  91 #define portIE_BIT                                      ( 0x00000001 )\r
  92 #define portEXL_BIT                                     ( 0x00000002 )\r
  93 \r
  94 /* The EXL bit is set to ensure interrupts do not occur while the context of\r
  95 the first task is being restored.  MEC14xx does not have DSP HW. */\r
  96 #define portINITIAL_SR                          ( portIE_BIT | portEXL_BIT )\r
  97 \r
  98 /* MEC14xx RTOS Timer MMCR's. */\r
  99 #define portMMCR_RTMR_PRELOAD   *((volatile uint32_t *)(0xA0007404ul))\r
 100 #define portMMCR_RTMR_CONTROL   *((volatile uint32_t *)(0xA0007408ul))\r
 101 \r
 102 /* MEC14xx JTVIC external interrupt controller is mapped to M14K closely-coupled\r
 103 peripheral space. */\r
 104 #define portGIRQ23_RTOS_TIMER_BITPOS    ( 4 )\r
 105 #define portGIRQ23_RTOS_TIMER_MASK              ( 1ul << ( portGIRQ23_RTOS_TIMER_BITPOS ) )\r
 106 #define portMMCR_JTVIC_GIRQ23_SRC               *((volatile uint32_t *)(0xBFFFC0F0ul))\r
 107 #define portMMCR_JTVIC_GIRQ23_SETEN             *((volatile uint32_t *)(0xBFFFC0F4ul))\r
 108 #define portMMCR_JTVIC_GIRQ23_PRIA              *((volatile uint32_t *)(0xBFFFC3F0ul))\r
 109 \r
 110 /* MIPS Software Interrupts are routed through JTVIC GIRQ24 */\r
 111 #define portGIRQ24_M14K_SOFTIRQ0_BITPOS ( 1 )\r
 112 #define portGIRQ24_M14K_SOFTIRQ0_MASK   ( 1ul << ( portGIRQ24_M14K_SOFTIRQ0_BITPOS ) )\r
 113 #define portMMCR_JTVIC_GIRQ24_SRC               *((volatile uint32_t *)(0xBFFFC100ul))\r
 114 #define portMMCR_JTVIC_GIRQ24_SETEN             *((volatile uint32_t *)(0xBFFFC104ul))\r
 115 #define portMMCR_JTVIC_GIRQ24_PRIA              *((volatile uint32_t *)(0xBFFFC400ul))\r
 116 \r
 117 /*\r
 118 By default port.c generates its tick interrupt from the RTOS timer.  The user\r
 119 can override this behaviour by:\r
 120         1: Providing their own implementation of vApplicationSetupTickTimerInterrupt(),\r
 121            which is the function that configures the timer.  The function is defined\r
 122            as a weak symbol in this file so if the same function name is used in the\r
 123            application code then the version in the application code will be linked\r
 124            into the application in preference to the version defined in this file.\r
 125         2: Provide a vector implementation in port_asm.S that overrides the default\r
 126            behaviour for the specified interrupt vector.\r
 127         3: Specify the correct bit to clear the interrupt during the timer interrupt\r
 128            handler.\r
 129 */\r
 130 #ifndef configTICK_INTERRUPT_VECTOR\r
 131         #define configTICK_INTERRUPT_VECTOR girq23_b4\r
 132         #define configCLEAR_TICK_TIMER_INTERRUPT() portMMCR_JTVIC_GIRQ23_SRC = portGIRQ23_RTOS_TIMER_MASK\r
 133 #else\r
 134         #ifndef configCLEAR_TICK_TIMER_INTERRUPT\r
 135                 #error If configTICK_INTERRUPT_VECTOR is defined in application code then configCLEAR_TICK_TIMER_INTERRUPT must also be defined in application code.\r
 136         #endif\r
 137 #endif\r
 138 \r
 139 /* Let the user override the pre-loading of the initial RA with the address of\r
 140 prvTaskExitError() in case it messes up unwinding of the stack in the debugger -\r
 141 in which case configTASK_RETURN_ADDRESS can be defined as 0 (NULL). */\r
 142 #ifdef configTASK_RETURN_ADDRESS\r
 143         #define portTASK_RETURN_ADDRESS configTASK_RETURN_ADDRESS\r
 144 #else\r
 145         #define portTASK_RETURN_ADDRESS prvTaskExitError\r
 146 #endif\r
 147 \r
 148 /* Set configCHECK_FOR_STACK_OVERFLOW to 3 to add ISR stack checking to task\r
 149 stack checking.  A problem in the ISR stack will trigger an assert, not call the\r
 150 stack overflow hook function (because the stack overflow hook is specific to a\r
 151 task stack, not the ISR stack). */\r
 152 #if( configCHECK_FOR_STACK_OVERFLOW > 2 )\r
 153 \r
 154         /* Don't use 0xa5 as the stack fill bytes as that is used by the kernel for\r
 155         the task stacks, and so will legitimately appear in many positions within\r
 156         the ISR stack. */\r
 157     #define portISR_STACK_FILL_BYTE     0xee\r
 158 \r
 159         static const uint8_t ucExpectedStackBytes[] = {\r
 160                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 161                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 162                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 163                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE,             \\r
 164                                                         portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE, portISR_STACK_FILL_BYTE };   \\r
 165 \r
 166         #define portCHECK_ISR_STACK() configASSERT( ( memcmp( ( void * ) xISRStack, ( void * ) ucExpectedStackBytes, sizeof( ucExpectedStackBytes ) ) == 0 ) )\r
 167 #else\r
 168         /* Define the function away. */\r
 169         #define portCHECK_ISR_STACK()\r
 170 #endif /* configCHECK_FOR_STACK_OVERFLOW > 2 */\r
 171 \r
 172 \r
 173 /*-----------------------------------------------------------*/\r
 174 \r
 175 /*\r
 176  * Used to catch tasks that attempt to return from their implementing function.\r
 177  */\r
 178 static void prvTaskExitError( void );\r
 179 \r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 /* Records the interrupt nesting depth.  This is initialised to one as it is\r
 183 decremented to 0 when the first task starts. */\r
 184 volatile UBaseType_t uxInterruptNesting = 0x01;\r
 185 \r
 186 /* Stores the task stack pointer when a switch is made to use the system stack. */\r
 187 UBaseType_t uxSavedTaskStackPointer = 0;\r
 188 \r
 189 /* The stack used by interrupt service routines that cause a context switch. */\r
 190 StackType_t xISRStack[ configISR_STACK_SIZE ] = { 0 };\r
 191 \r
 192 /* The top of stack value ensures there is enough space to store 6 registers on\r
 193 the callers stack, as some functions seem to want to do this. */\r
 194 const StackType_t * const xISRStackTop = &( xISRStack[ configISR_STACK_SIZE - 7 ] );\r
 195 \r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 /*\r
 199  * See header file for description.\r
 200  */\r
 201 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
 202 {\r
 203         /* Ensure byte alignment is maintained when leaving this function. */\r
 204         pxTopOfStack--;\r
 205 \r
 206         *pxTopOfStack = (StackType_t) 0xDEADBEEF;\r
 207         pxTopOfStack--;\r
 208 \r
 209         *pxTopOfStack = (StackType_t) 0x12345678;       /* Word to which the stack pointer will be left pointing after context restore. */\r
 210         pxTopOfStack--;\r
 211 \r
 212         *pxTopOfStack = (StackType_t) ulPortGetCP0Cause();\r
 213         pxTopOfStack--;\r
 214 \r
 215         *pxTopOfStack = (StackType_t) portINITIAL_SR;   /* CP0_STATUS */\r
 216         pxTopOfStack--;\r
 217 \r
 218         *pxTopOfStack = (StackType_t) pxCode;           /* CP0_EPC */\r
 219         pxTopOfStack--;\r
 220 \r
 221         *pxTopOfStack = (StackType_t) portTASK_RETURN_ADDRESS;  /* ra */\r
 222         pxTopOfStack -= 15;\r
 223 \r
 224         *pxTopOfStack = (StackType_t) pvParameters; /* Parameters to pass in. */\r
 225         pxTopOfStack -= 15;\r
 226 \r
 227         return pxTopOfStack;\r
 228 }\r
 229 /*-----------------------------------------------------------*/\r
 230 \r
 231 static __inline uint32_t prvDisableInterrupt( void )\r
 232 {\r
 233 uint32_t prev_state;\r
 234 \r
 235         __asm volatile( "di %0; ehb" : "=r" ( prev_state ) :: "memory" );\r
 236         return prev_state;\r
 237 }\r
 238 /*-----------------------------------------------------------*/\r
 239 \r
 240 static void prvTaskExitError( void )\r
 241 {\r
 242         /* A function that implements a task must not exit or attempt to return to\r
 243         its caller as there is nothing to return to.  If a task wants to exit it\r
 244         should instead call vTaskDelete( NULL ).\r
 245 \r
 246         Artificially force an assert() to be triggered if configASSERT() is\r
 247         defined, then stop here so application writers can catch the error. */\r
 248         configASSERT( uxSavedTaskStackPointer == 0UL );\r
 249         portDISABLE_INTERRUPTS();\r
 250         for( ;; );\r
 251 }\r
 252 /*-----------------------------------------------------------*/\r
 253 \r
 254 /*\r
 255  * Setup a timer for a regular tick.  This function uses the RTOS timer.\r
 256  * The function is declared weak so an application writer can use a different\r
 257  * timer by redefining this implementation.  If a different timer is used then\r
 258  * configTICK_INTERRUPT_VECTOR must also be defined in FreeRTOSConfig.h to\r
 259  * ensure the RTOS provided tick interrupt handler is installed on the correct\r
 260  * vector number.\r
 261  */\r
 262 __attribute__(( weak )) void vApplicationSetupTickTimerInterrupt( void )\r
 263 {\r
 264 /* MEC14xx RTOS Timer whose input clock is 32KHz. */\r
 265 const uint32_t ulPreload = ( 32768ul / ( configTICK_RATE_HZ ) );\r
 266 \r
 267         configASSERT( ulPreload != 0UL );\r
 268 \r
 269         /* Configure the RTOS timer. */\r
 270         portMMCR_RTMR_CONTROL = 0ul;\r
 271         portMMCR_RTMR_PRELOAD = ulPreload;\r
 272 \r
 273         /* Configure interrupts from the RTOS timer. */\r
 274         portMMCR_JTVIC_GIRQ23_SRC = ( portGIRQ23_RTOS_TIMER_MASK );\r
 275         portMMCR_JTVIC_GIRQ23_PRIA &= ~( 0x0Ful << 16 );\r
 276         portMMCR_JTVIC_GIRQ23_PRIA |= ( ( portIPL_TO_CODE( configKERNEL_INTERRUPT_PRIORITY ) ) << 16 );\r
 277         portMMCR_JTVIC_GIRQ23_SETEN = ( portGIRQ23_RTOS_TIMER_MASK );\r
 278 \r
 279         /* Enable the RTOS timer. */\r
 280         portMMCR_RTMR_CONTROL = 0x0Fu;\r
 281 }\r
 282 /*-----------------------------------------------------------*/\r
 283 \r
 284 void vPortEndScheduler(void)\r
 285 {\r
 286         /* Not implemented in ports where there is nothing to return to.\r
 287         Artificially force an assert. */\r
 288         configASSERT( uxInterruptNesting == 1000UL );\r
 289 }\r
 290 /*-----------------------------------------------------------*/\r
 291 \r
 292 BaseType_t xPortStartScheduler( void )\r
 293 {\r
 294 extern void vPortStartFirstTask( void );\r
 295 extern void *pxCurrentTCB;\r
 296 \r
 297         #if ( configCHECK_FOR_STACK_OVERFLOW > 2 )\r
 298         {\r
 299                 /* Fill the ISR stack to make it easy to asses how much is being used. */\r
 300                 memset( ( void * ) xISRStack, portISR_STACK_FILL_BYTE, sizeof( xISRStack ) );\r
 301         }\r
 302         #endif /* configCHECK_FOR_STACK_OVERFLOW > 2 */\r
 303 \r
 304         /* Clear the software interrupt flag. */\r
 305         portMMCR_JTVIC_GIRQ24_SRC = (portGIRQ24_M14K_SOFTIRQ0_MASK);\r
 306 \r
 307         /* Set software timer priority.  Each GIRQn has one nibble containing its\r
 308         priority */\r
 309         portMMCR_JTVIC_GIRQ24_PRIA &= ~(0xF0ul);\r
 310         portMMCR_JTVIC_GIRQ24_PRIA |= ( portIPL_TO_CODE( configKERNEL_INTERRUPT_PRIORITY ) << 4 );\r
 311 \r
 312         /* Enable software interrupt. */\r
 313         portMMCR_JTVIC_GIRQ24_SETEN = ( portGIRQ24_M14K_SOFTIRQ0_MASK );\r
 314 \r
 315         /* Setup the timer to generate the tick.  Interrupts will have been disabled\r
 316         by the time we get here. */\r
 317         vApplicationSetupTickTimerInterrupt();\r
 318 \r
 319         /* Start the highest priority task that has been created so far.  Its stack\r
 320         location is loaded into uxSavedTaskStackPointer. */\r
 321         uxSavedTaskStackPointer = *( UBaseType_t * ) pxCurrentTCB;\r
 322         vPortStartFirstTask();\r
 323 \r
 324         /* Should never get here as the tasks will now be executing!  Call the task\r
 325         exit error function to prevent compiler warnings about a static function\r
 326         not being called in the case that the application writer overrides this\r
 327         functionality by defining configTASK_RETURN_ADDRESS. */\r
 328         prvTaskExitError();\r
 329 \r
 330         return pdFALSE;\r
 331 }\r
 332 /*-----------------------------------------------------------*/\r
 333 \r
 334 void vPortIncrementTick( void )\r
 335 {\r
 336 UBaseType_t uxSavedStatus;\r
 337 uint32_t ulCause;\r
 338 \r
 339         uxSavedStatus = uxPortSetInterruptMaskFromISR();\r
 340         {\r
 341                 if( xTaskIncrementTick() != pdFALSE )\r
 342                 {\r
 343                         /* Pend a context switch. */\r
 344                         ulCause = ulPortGetCP0Cause();\r
 345                         ulCause |= ( 1ul << 8UL );\r
 346                         vPortSetCP0Cause( ulCause );\r
 347                 }\r
 348         }\r
 349         vPortClearInterruptMaskFromISR( uxSavedStatus );\r
 350 \r
 351         /* Look for the ISR stack getting near or past its limit. */\r
 352         portCHECK_ISR_STACK();\r
 353 \r
 354         /* Clear timer interrupt. */\r
 355         configCLEAR_TICK_TIMER_INTERRUPT();\r
 356 }\r
 357 /*-----------------------------------------------------------*/\r
 358 \r
 359 UBaseType_t uxPortSetInterruptMaskFromISR( void )\r
 360 {\r
 361 UBaseType_t uxSavedStatusRegister;\r
 362 \r
 363         prvDisableInterrupt();\r
 364         uxSavedStatusRegister = ulPortGetCP0Status() | 0x01;\r
 365 \r
 366         /* This clears the IPL bits, then sets them to\r
 367         configMAX_SYSCALL_INTERRUPT_PRIORITY.  This function should not be called\r
 368         from an interrupt that has a priority above\r
 369         configMAX_SYSCALL_INTERRUPT_PRIORITY so, when used correctly, the action\r
 370         can only result in the IPL being unchanged or raised, and therefore never\r
 371         lowered. */\r
 372         vPortSetCP0Status( ( ( uxSavedStatusRegister & ( ~portALL_IPL_BITS ) ) ) | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) );\r
 373 \r
 374         return uxSavedStatusRegister;\r
 375 }\r
 376 /*-----------------------------------------------------------*/\r
 377 \r
 378 void vPortClearInterruptMaskFromISR( UBaseType_t uxSavedStatusRegister )\r
 379 {\r
 380         vPortSetCP0Status( uxSavedStatusRegister );\r
 381 }\r
 382 /*-----------------------------------------------------------*/\r
 383 \r
 384 \r
 385 \r
 386 \r
 387 \r