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

   1 /*\r
   2     FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 /*-----------------------------------------------------------\r
  66  * Implementation of functions defined in portable.h for the PIC32MX port.\r
  67   *----------------------------------------------------------*/\r
  68 \r
  69 #ifndef __XC\r
  70     #error This port is designed to work with XC32.  Please update your C compiler version.\r
  71 #endif\r
  72 \r
  73 /* Scheduler include files. */\r
  74 #include "FreeRTOS.h"\r
  75 #include "task.h"\r
  76 \r
  77 /* Hardware specifics. */\r
  78 #define portTIMER_PRESCALE      8\r
  79 #define portPRESCALE_BITS       1\r
  80 \r
  81 /* Bits within various registers. */\r
  82 #define portIE_BIT                                              ( 0x00000001 )\r
  83 #define portEXL_BIT                                             ( 0x00000002 )\r
  84 \r
  85 /* Bits within the CAUSE register. */\r
  86 #define portCORE_SW_0                                   ( 0x00000100 )\r
  87 #define portCORE_SW_1                                   ( 0x00000200 )\r
  88 \r
  89 /* The EXL bit is set to ensure interrupts do not occur while the context of\r
  90 the first task is being restored. */\r
  91 #define portINITIAL_SR                                  ( portIE_BIT | portEXL_BIT )\r
  92 \r
  93 #ifndef configTICK_INTERRUPT_VECTOR\r
  94         #define configTICK_INTERRUPT_VECTOR _TIMER_1_VECTOR\r
  95 #endif\r
  96 \r
  97 /* Records the interrupt nesting depth.  This starts at one as it will be\r
  98 decremented to 0 when the first task starts. */\r
  99 volatile unsigned portBASE_TYPE uxInterruptNesting = 0x01;\r
 100 \r
 101 /* Stores the task stack pointer when a switch is made to use the system stack. */\r
 102 unsigned portBASE_TYPE uxSavedTaskStackPointer = 0;\r
 103 \r
 104 /* The stack used by interrupt service routines that cause a context switch. */\r
 105 portSTACK_TYPE xISRStack[ configISR_STACK_SIZE ] = { 0 };\r
 106 \r
 107 /* The top of stack value ensures there is enough space to store 6 registers on\r
 108 the callers stack, as some functions seem to want to do this. */\r
 109 const portSTACK_TYPE * const xISRStackTop = &( xISRStack[ configISR_STACK_SIZE - 7 ] );\r
 110 \r
 111 /*\r
 112  * Place the prototype here to ensure the interrupt vector is correctly installed.\r
 113  * Note that because the interrupt is written in assembly, the IPL setting in the\r
 114  * following line of code has no effect.  The interrupt priority is set by the\r
 115  * call to ConfigIntTimer1() in vApplicationSetupTickTimerInterrupt().\r
 116  */\r
 117 extern void __attribute__( (interrupt(ipl1), vector( configTICK_INTERRUPT_VECTOR ))) vPortTickInterruptHandler( void );\r
 118 \r
 119 /*\r
 120  * The software interrupt handler that performs the yield.  Note that, because\r
 121  * the interrupt is written in assembly, the IPL setting in the following line of\r
 122  * code has no effect.  The interrupt priority is set by the call to\r
 123  * mConfigIntCoreSW0() in xPortStartScheduler().\r
 124  */\r
 125 void __attribute__( (interrupt(ipl1), vector(_CORE_SOFTWARE_0_VECTOR))) vPortYieldISR( void );\r
 126 \r
 127 /*-----------------------------------------------------------*/\r
 128 \r
 129 /*\r
 130  * See header file for description.\r
 131  */\r
 132 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 133 {\r
 134         /* Ensure byte alignment is maintained when leaving this function. */\r
 135         pxTopOfStack--;\r
 136 \r
 137         *pxTopOfStack = (portSTACK_TYPE) 0xDEADBEEF;\r
 138         pxTopOfStack--;\r
 139 \r
 140         *pxTopOfStack = (portSTACK_TYPE) 0x12345678;    /* Word to which the stack pointer will be left pointing after context restore. */\r
 141         pxTopOfStack--;\r
 142 \r
 143         *pxTopOfStack = (portSTACK_TYPE) _CP0_GET_CAUSE();\r
 144         pxTopOfStack--;\r
 145 \r
 146         *pxTopOfStack = (portSTACK_TYPE) portINITIAL_SR; /* CP0_STATUS */\r
 147         pxTopOfStack--;\r
 148 \r
 149         *pxTopOfStack = (portSTACK_TYPE) pxCode;                /* CP0_EPC */\r
 150         pxTopOfStack--;\r
 151 \r
 152         *pxTopOfStack = (portSTACK_TYPE) NULL;                  /* ra */\r
 153         pxTopOfStack -= 15;\r
 154 \r
 155         *pxTopOfStack = (portSTACK_TYPE) pvParameters; /* Parameters to pass in */\r
 156         pxTopOfStack -= 14;\r
 157 \r
 158         *pxTopOfStack = (portSTACK_TYPE) 0x00000000;    /* critical nesting level - no longer used. */\r
 159         pxTopOfStack--;\r
 160 \r
 161         return pxTopOfStack;\r
 162 }\r
 163 /*-----------------------------------------------------------*/\r
 164 \r
 165 /*\r
 166  * Setup a timer for a regular tick.  This function uses peripheral timer 1.\r
 167  * The function is declared weak so an application writer can use a different\r
 168  * timer by redefining this implementation.  If a different timer is used then\r
 169  * configTICK_INTERRUPT_VECTOR must also be defined in FreeRTOSConfig.h to\r
 170  * ensure the RTOS provided tick interrupt handler is installed on the correct\r
 171  * vector number.  When Timer 1 is used the vector number is defined as\r
 172  * _TIMER_1_VECTOR.\r
 173  */\r
 174 __attribute__(( weak )) void vApplicationSetupTickTimerInterrupt( void )\r
 175 {\r
 176 const unsigned long ulCompareMatch = ( (configPERIPHERAL_CLOCK_HZ / portTIMER_PRESCALE) / configTICK_RATE_HZ ) - 1;\r
 177 \r
 178         T1CON = 0x0000;\r
 179         T1CONbits.TCKPS = portPRESCALE_BITS;\r
 180         PR1 = ulCompareMatch;\r
 181         IPC1bits.T1IP = configKERNEL_INTERRUPT_PRIORITY;\r
 182 \r
 183         /* Clear the interrupt as a starting condition. */\r
 184         IFS0bits.T1IF = 0;\r
 185 \r
 186         /* Enable the interrupt. */\r
 187         IEC0bits.T1IE = 1;\r
 188 \r
 189         /* Start the timer. */\r
 190         T1CONbits.TON = 1;\r
 191 }\r
 192 /*-----------------------------------------------------------*/\r
 193 \r
 194 void vPortEndScheduler(void)\r
 195 {\r
 196         /* It is unlikely that the scheduler for the PIC port will get stopped\r
 197         once running.  If required disable the tick interrupt here, then return\r
 198         to xPortStartScheduler(). */\r
 199         for( ;; );\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 portBASE_TYPE xPortStartScheduler( void )\r
 204 {\r
 205 extern void vPortStartFirstTask( void );\r
 206 extern void *pxCurrentTCB;\r
 207 \r
 208         /* Clear the software interrupt flag. */\r
 209         IFS0CLR = _IFS0_CS0IF_MASK;\r
 210 \r
 211         /* Set software timer priority. */\r
 212         IPC0CLR = _IPC0_CS0IP_MASK;\r
 213         IPC0SET = ( configKERNEL_INTERRUPT_PRIORITY << _IPC0_CS0IP_POSITION );\r
 214 \r
 215         /* Enable software interrupt. */\r
 216         IEC0CLR = _IEC0_CS0IE_MASK;\r
 217         IEC0SET = 1 << _IEC0_CS0IE_POSITION;\r
 218 \r
 219         /* Setup the timer to generate the tick.  Interrupts will have been\r
 220         disabled by the time we get here. */\r
 221         vApplicationSetupTickTimerInterrupt();\r
 222 \r
 223         /* Kick off the highest priority task that has been created so far.\r
 224         Its stack location is loaded into uxSavedTaskStackPointer. */\r
 225         uxSavedTaskStackPointer = *( unsigned portBASE_TYPE * ) pxCurrentTCB;\r
 226         vPortStartFirstTask();\r
 227 \r
 228         /* Should never get here as the tasks will now be executing. */\r
 229         return pdFALSE;\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 void vPortIncrementTick( void )\r
 234 {\r
 235 unsigned portBASE_TYPE uxSavedStatus;\r
 236 \r
 237         uxSavedStatus = uxPortSetInterruptMaskFromISR();\r
 238         {\r
 239                 if( xTaskIncrementTick() != pdFALSE )\r
 240                 {\r
 241                         /* Pend a context switch. */\r
 242                         _CP0_BIS_CAUSE( portCORE_SW_0 );\r
 243                 }\r
 244         }\r
 245         vPortClearInterruptMaskFromISR( uxSavedStatus );\r
 246 \r
 247         /* Clear timer 1 interrupt. */\r
 248         IFS0CLR = _IFS0_T1IF_MASK;\r
 249 }\r
 250 /*-----------------------------------------------------------*/\r
 251 \r
 252 unsigned portBASE_TYPE uxPortSetInterruptMaskFromISR( void )\r
 253 {\r
 254 unsigned portBASE_TYPE uxSavedStatusRegister;\r
 255 \r
 256         asm volatile ( "di" );\r
 257         uxSavedStatusRegister = _CP0_GET_STATUS() | 0x01;\r
 258         /* This clears the IPL bits, then sets them to\r
 259         configMAX_SYSCALL_INTERRUPT_PRIORITY.  This function should not be called\r
 260         from an interrupt that has a priority above\r
 261         configMAX_SYSCALL_INTERRUPT_PRIORITY so, when used correctly, the action\r
 262         can only result in the IPL being unchanged or raised, and therefore never\r
 263         lowered. */\r
 264         _CP0_SET_STATUS( ( ( uxSavedStatusRegister & ( ~portALL_IPL_BITS ) ) ) | ( configMAX_SYSCALL_INTERRUPT_PRIORITY << portIPL_SHIFT ) );\r
 265 \r
 266         return uxSavedStatusRegister;\r
 267 }\r
 268 /*-----------------------------------------------------------*/\r
 269 \r
 270 void vPortClearInterruptMaskFromISR( unsigned portBASE_TYPE uxSavedStatusRegister )\r
 271 {\r
 272         _CP0_SET_STATUS( uxSavedStatusRegister );\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 \r
 277 \r
 278 \r
 279 \r