git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MPLAB/PIC32MX/ISR_Support.h

   1 /*\r
   2     FreeRTOS V9.0.0rc2 - 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 #include "FreeRTOSConfig.h"\r
  71 \r
  72 #define portCONTEXT_SIZE 132\r
  73 #define portEPC_STACK_LOCATION  124\r
  74 #define portSTATUS_STACK_LOCATION 128\r
  75 \r
  76 /******************************************************************/\r
  77 .macro  portSAVE_CONTEXT\r
  78 \r
  79         /* Make room for the context. First save the current status so it can be\r
  80         manipulated, and the cause and EPC registers so their original values are\r
  81         captured. */\r
  82         mfc0            k0, _CP0_CAUSE\r
  83         addiu           sp,     sp, -portCONTEXT_SIZE\r
  84         mfc0            k1, _CP0_STATUS\r
  85 \r
  86         /* Also save s6 and s5 so they can be used.  Any nesting interrupts should\r
  87         maintain the values of these registers across the ISR. */\r
  88         sw                      s6, 44(sp)\r
  89         sw                      s5, 40(sp)\r
  90         sw                      k1, portSTATUS_STACK_LOCATION(sp)\r
  91 \r
  92         /* Prepare to enable interrupts above the current priority. */\r
  93         srl                     k0, k0, 0xa\r
  94         ins             k1, k0, 10, 6\r
  95         ins                     k1, zero, 1, 4\r
  96 \r
  97         /* s5 is used as the frame pointer. */\r
  98         add                     s5, zero, sp\r
  99 \r
 100         /* Check the nesting count value. */\r
 101         la                      k0, uxInterruptNesting\r
 102         lw                      s6, (k0)\r
 103 \r
 104         /* If the nesting count is 0 then swap to the the system stack, otherwise\r
 105         the system stack is already being used. */\r
 106         bne                     s6, zero, 1f\r
 107         nop\r
 108 \r
 109         /* Swap to the system stack. */\r
 110         la                      sp, xISRStackTop\r
 111         lw                      sp, (sp)\r
 112 \r
 113         /* Increment and save the nesting count. */\r
 114 1:      addiu           s6, s6, 1\r
 115         sw                      s6, 0(k0)\r
 116 \r
 117         /* s6 holds the EPC value, this is saved after interrupts are re-enabled. */\r
 118         mfc0            s6, _CP0_EPC\r
 119 \r
 120         /* Re-enable interrupts. */\r
 121         mtc0            k1, _CP0_STATUS\r
 122 \r
 123         /* Save the context into the space just created.  s6 is saved again\r
 124         here as it now contains the EPC value.  No other s registers need be\r
 125         saved. */\r
 126         sw                      ra, 120(s5)\r
 127         sw                      s8, 116(s5)\r
 128         sw                      t9, 112(s5)\r
 129         sw                      t8, 108(s5)\r
 130         sw                      t7, 104(s5)\r
 131         sw                      t6, 100(s5)\r
 132         sw                      t5, 96(s5)\r
 133         sw                      t4, 92(s5)\r
 134         sw                      t3, 88(s5)\r
 135         sw                      t2, 84(s5)\r
 136         sw                      t1, 80(s5)\r
 137         sw                      t0, 76(s5)\r
 138         sw                      a3, 72(s5)\r
 139         sw                      a2, 68(s5)\r
 140         sw                      a1, 64(s5)\r
 141         sw                      a0, 60(s5)\r
 142         sw                      v1, 56(s5)\r
 143         sw                      v0, 52(s5)\r
 144         sw                      s6, portEPC_STACK_LOCATION(s5)\r
 145         sw                      $1, 16(s5)\r
 146 \r
 147         /* s6 is used as a scratch register. */\r
 148         mfhi            s6\r
 149         sw                      s6, 12(s5)\r
 150         mflo            s6\r
 151         sw                      s6, 8(s5)\r
 152 \r
 153         /* Update the task stack pointer value if nesting is zero. */\r
 154         la                      s6, uxInterruptNesting\r
 155         lw                      s6, (s6)\r
 156         addiu           s6, s6, -1\r
 157         bne                     s6, zero, 1f\r
 158         nop\r
 159 \r
 160         /* Save the stack pointer. */\r
 161         la                      s6, uxSavedTaskStackPointer\r
 162         sw                      s5, (s6)\r
 163 1:\r
 164         .endm\r
 165 \r
 166 /******************************************************************/\r
 167 .macro  portRESTORE_CONTEXT\r
 168 \r
 169         /* Restore the stack pointer from the TCB.  This is only done if the\r
 170         nesting count is 1. */\r
 171         la                      s6, uxInterruptNesting\r
 172         lw                      s6, (s6)\r
 173         addiu           s6, s6, -1\r
 174         bne                     s6, zero, 1f\r
 175         nop\r
 176         la                      s6, uxSavedTaskStackPointer\r
 177         lw                      s5, (s6)\r
 178 \r
 179         /* Restore the context. */\r
 180 1:      lw                      s6, 8(s5)\r
 181         mtlo            s6\r
 182         lw                      s6, 12(s5)\r
 183         mthi            s6\r
 184         lw                      $1, 16(s5)\r
 185         /* s6 is loaded as it was used as a scratch register and therefore saved\r
 186         as part of the interrupt context. */\r
 187         lw                      s6, 44(s5)\r
 188         lw                      v0, 52(s5)\r
 189         lw                      v1, 56(s5)\r
 190         lw                      a0, 60(s5)\r
 191         lw                      a1, 64(s5)\r
 192         lw                      a2, 68(s5)\r
 193         lw                      a3, 72(s5)\r
 194         lw                      t0, 76(s5)\r
 195         lw                      t1, 80(s5)\r
 196         lw                      t2, 84(s5)\r
 197         lw                      t3, 88(s5)\r
 198         lw                      t4, 92(s5)\r
 199         lw                      t5, 96(s5)\r
 200         lw                      t6, 100(s5)\r
 201         lw                      t7, 104(s5)\r
 202         lw                      t8, 108(s5)\r
 203         lw                      t9, 112(s5)\r
 204         lw                      s8, 116(s5)\r
 205         lw                      ra, 120(s5)\r
 206 \r
 207         /* Protect access to the k registers, and others. */\r
 208         di\r
 209         ehb\r
 210 \r
 211         /* Decrement the nesting count. */\r
 212         la                      k0, uxInterruptNesting\r
 213         lw                      k1, (k0)\r
 214         addiu           k1, k1, -1\r
 215         sw                      k1, 0(k0)\r
 216 \r
 217         lw                      k0, portSTATUS_STACK_LOCATION(s5)\r
 218         lw                      k1, portEPC_STACK_LOCATION(s5)\r
 219 \r
 220         /* Leave the stack in its original state.  First load sp from s5, then\r
 221         restore s5 from the stack. */\r
 222         add                     sp, zero, s5\r
 223         lw                      s5, 40(sp)\r
 224         addiu           sp, sp, portCONTEXT_SIZE\r
 225 \r
 226         mtc0            k0, _CP0_STATUS\r
 227         mtc0            k1, _CP0_EPC\r
 228         ehb\r
 229         eret\r
 230         nop\r
 231 \r
 232         .endm\r
 233 \r