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

   1 /*\r
   2     FreeRTOS V7.1.1 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\r
  22     ***************************************************************************\r
  23 \r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43     \r
  44     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 #include "FreeRTOSConfig.h"\r
  68 \r
  69 #define portCONTEXT_SIZE 132\r
  70 #define portEPC_STACK_LOCATION  124\r
  71 #define portSTATUS_STACK_LOCATION 128\r
  72 \r
  73 /******************************************************************/    \r
  74 .macro  portSAVE_CONTEXT\r
  75 \r
  76         /* Make room for the context. First save the current status so we can \r
  77         manipulate it, and the cause and EPC registers so we capture their \r
  78         original values in case of interrupt nesting. */\r
  79         mfc0            k0, _CP0_CAUSE\r
  80         addiu           sp,     sp, -portCONTEXT_SIZE\r
  81         mfc0            k1, _CP0_STATUS\r
  82 \r
  83         /* Also save s6 and s5 so we can use them during this interrupt.  Any\r
  84         nesting interrupts should maintain the values of these registers\r
  85         across the ISR. */\r
  86         sw                      s6, 44(sp)\r
  87         sw                      s5, 40(sp)\r
  88         sw                      k1, portSTATUS_STACK_LOCATION(sp)\r
  89 \r
  90         /* Enable interrupts above the current priority. */\r
  91         srl                     k0, k0, 0xa\r
  92         ins             k1, k0, 10, 6\r
  93         ins                     k1, zero, 1, 4\r
  94 \r
  95         /* s5 is used as the frame pointer. */\r
  96         add                     s5, zero, sp\r
  97 \r
  98         /* Check the nesting count value. */\r
  99         la                      k0, uxInterruptNesting\r
 100         lw                      s6, (k0)\r
 101 \r
 102         /* If the nesting count is 0 then swap to the the system stack, otherwise\r
 103         the system stack is already being used. */\r
 104         bne                     s6, zero, .+20\r
 105         nop\r
 106 \r
 107         /* Swap to the system stack. */\r
 108         la                      sp, xISRStackTop\r
 109         lw                      sp, (sp)\r
 110 \r
 111         /* Increment and save the nesting count. */\r
 112         addiu           s6, s6, 1\r
 113         sw                      s6, 0(k0)\r
 114 \r
 115         /* s6 holds the EPC value, this is saved after interrupts are re-enabled. */\r
 116         mfc0            s6, _CP0_EPC\r
 117 \r
 118         /* Re-enable interrupts. */\r
 119         mtc0            k1, _CP0_STATUS\r
 120 \r
 121         /* Save the context into the space just created.  s6 is saved again\r
 122         here as it now contains the EPC value.  No other s registers need be\r
 123         saved. */\r
 124         sw                      ra,     120(s5)\r
 125         sw                      s8, 116(s5)\r
 126         sw                      t9, 112(s5)\r
 127         sw                      t8,     108(s5)\r
 128         sw                      t7,     104(s5)\r
 129         sw                      t6, 100(s5)\r
 130         sw                      t5, 96(s5)\r
 131         sw                      t4, 92(s5)\r
 132         sw                      t3, 88(s5)\r
 133         sw                      t2, 84(s5)\r
 134         sw                      t1, 80(s5)\r
 135         sw                      t0, 76(s5)\r
 136         sw                      a3, 72(s5)\r
 137         sw                      a2, 68(s5)\r
 138         sw                      a1, 64(s5)\r
 139         sw                      a0, 60(s5)\r
 140         sw                      v1, 56(s5)\r
 141         sw                      v0, 52(s5)\r
 142         sw                      s6, portEPC_STACK_LOCATION(s5)\r
 143         sw                      $1, 16(s5)\r
 144 \r
 145         /* s6 is used as a scratch register. */\r
 146         mfhi            s6\r
 147         sw                      s6, 12(s5)\r
 148         mflo            s6\r
 149         sw                      s6, 8(s5)\r
 150 \r
 151         /* Update the task stack pointer value if nesting is zero. */\r
 152         la                      s6, uxInterruptNesting\r
 153         lw                      s6, (s6)\r
 154         addiu           s6, s6, -1\r
 155         bne                     s6, zero, .+20\r
 156         nop\r
 157 \r
 158         /* Save the stack pointer. */\r
 159         la                      s6, uxSavedTaskStackPointer\r
 160         sw                      s5, (s6)\r
 161 \r
 162         .endm\r
 163         \r
 164 /******************************************************************/    \r
 165 .macro  portRESTORE_CONTEXT\r
 166 \r
 167         /* Restore the stack pointer from the TCB.  This is only done if the\r
 168         nesting count is 1. */\r
 169         la                      s6, uxInterruptNesting\r
 170         lw                      s6, (s6)\r
 171         addiu           s6, s6, -1\r
 172         bne                     s6, zero, .+20\r
 173         nop\r
 174         la                      s6, uxSavedTaskStackPointer\r
 175         lw                      s5, (s6)\r
 176         \r
 177         /* Restore the context. */\r
 178         lw                      s6, 8(s5)\r
 179         mtlo            s6\r
 180         lw                      s6, 12(s5)\r
 181         mthi            s6\r
 182         lw                      $1, 16(s5)\r
 183         /* s6 is loaded as it was used as a scratch register and therefore saved\r
 184         as part of the interrupt context. */\r
 185         lw                      s6, 44(s5)\r
 186         lw                      v0, 52(s5)\r
 187         lw                      v1, 56(s5)\r
 188         lw                      a0, 60(s5)\r
 189         lw                      a1, 64(s5)\r
 190         lw                      a2, 68(s5)\r
 191         lw                      a3, 72(s5)\r
 192         lw                      t0, 76(s5)\r
 193         lw                      t1, 80(s5)\r
 194         lw                      t2, 84(s5)\r
 195         lw                      t3, 88(s5)\r
 196         lw                      t4, 92(s5)\r
 197         lw                      t5, 96(s5)\r
 198         lw                      t6, 100(s5)\r
 199         lw                      t7, 104(s5)\r
 200         lw                      t8, 108(s5)\r
 201         lw                      t9, 112(s5)\r
 202         lw                      s8, 116(s5)\r
 203         lw                      ra, 120(s5)\r
 204 \r
 205         /* Protect access to the k registers, and others. */\r
 206         di\r
 207 \r
 208         /* Decrement the nesting count. */\r
 209         la                      k0, uxInterruptNesting\r
 210         lw                      k1, (k0)\r
 211         addiu           k1, k1, -1\r
 212         sw                      k1, 0(k0)\r
 213 \r
 214         lw                      k0, portSTATUS_STACK_LOCATION(s5)\r
 215         lw                      k1, portEPC_STACK_LOCATION(s5)\r
 216 \r
 217         /* Leave the stack how we found it.  First load sp from s5, then restore\r
 218         s5 from the stack. */\r
 219         add                     sp, zero, s5\r
 220         lw                      s5, 40(sp)\r
 221         addiu           sp,     sp,     portCONTEXT_SIZE\r
 222 \r
 223         mtc0            k0, _CP0_STATUS\r
 224         mtc0            k1, _CP0_EPC\r
 225         ehb\r
 226         eret \r
 227         nop\r
 228 \r
 229         .endm\r
 230 \r