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

   1 /*\r
   2     FreeRTOS V8.2.2 - 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 #include "FreeRTOSConfig.h"\r
  71 \r
  72 #define portCONTEXT_SIZE 160\r
  73 #define portEPC_STACK_LOCATION 152\r
  74 #define portSTATUS_STACK_LOCATION 156\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, 7\r
  95         srl                     k0, k0, 0x7 /* This copies the MSB of the IPL, but it would be an error if it was set anyway. */\r
  96         ins             k1, k0, 18, 1\r
  97         ins                     k1, zero, 1, 4\r
  98 \r
  99         /* s5 is used as the frame pointer. */\r
 100         add                     s5, zero, sp\r
 101 \r
 102         /* Check the nesting count value. */\r
 103         la                      k0, uxInterruptNesting\r
 104         lw                      s6, (k0)\r
 105 \r
 106         /* If the nesting count is 0 then swap to the the system stack, otherwise\r
 107         the system stack is already being used. */\r
 108         bne                     s6, zero, 1f\r
 109         nop\r
 110 \r
 111         /* Swap to the system stack. */\r
 112         la                      sp, xISRStackTop\r
 113         lw                      sp, (sp)\r
 114 \r
 115         /* Increment and save the nesting count. */\r
 116 1:      addiu           s6, s6, 1\r
 117         sw                      s6, 0(k0)\r
 118 \r
 119         /* s6 holds the EPC value, this is saved after interrupts are re-enabled. */\r
 120         mfc0            s6, _CP0_EPC\r
 121 \r
 122         /* Re-enable interrupts. */\r
 123         mtc0            k1, _CP0_STATUS\r
 124 \r
 125         /* Save the context into the space just created.  s6 is saved again\r
 126         here as it now contains the EPC value.  No other s registers need be\r
 127         saved. */\r
 128         sw                      ra, 120(s5)\r
 129         sw                      s8, 116(s5)\r
 130         sw                      t9, 112(s5)\r
 131         sw                      t8, 108(s5)\r
 132         sw                      t7, 104(s5)\r
 133         sw                      t6, 100(s5)\r
 134         sw                      t5, 96(s5)\r
 135         sw                      t4, 92(s5)\r
 136         sw                      t3, 88(s5)\r
 137         sw                      t2, 84(s5)\r
 138         sw                      t1, 80(s5)\r
 139         sw                      t0, 76(s5)\r
 140         sw                      a3, 72(s5)\r
 141         sw                      a2, 68(s5)\r
 142         sw                      a1, 64(s5)\r
 143         sw                      a0, 60(s5)\r
 144         sw                      v1, 56(s5)\r
 145         sw                      v0, 52(s5)\r
 146         sw                      s6, portEPC_STACK_LOCATION(s5)\r
 147         sw                      $1, 16(s5)\r
 148 \r
 149         /* Save the AC0, AC1, AC2, AC3 registers from the DSP.  s6 is used as a\r
 150         scratch register. */\r
 151         mfhi            s6, $ac1\r
 152         sw                      s6, 128(s5)\r
 153         mflo            s6, $ac1\r
 154         sw                      s6, 124(s5)\r
 155 \r
 156         mfhi            s6, $ac2\r
 157         sw                      s6, 136(s5)\r
 158         mflo            s6, $ac2\r
 159         sw                      s6, 132(s5)\r
 160 \r
 161         mfhi            s6, $ac3\r
 162         sw                      s6, 144(s5)\r
 163         mflo            s6, $ac3\r
 164         sw                      s6, 140(s5)\r
 165 \r
 166         /* Save the DSP Control register */\r
 167         rddsp           s6\r
 168         sw                      s6, 148(s5)\r
 169 \r
 170         /* ac0 is done separately to match the MX port. */\r
 171         mfhi            s6, $ac0\r
 172         sw                      s6, 12(s5)\r
 173         mflo            s6, $ac0\r
 174         sw                      s6, 8(s5)\r
 175 \r
 176         /* Update the task stack pointer value if nesting is zero. */\r
 177         la                      s6, uxInterruptNesting\r
 178         lw                      s6, (s6)\r
 179         addiu           s6, s6, -1\r
 180         bne                     s6, zero, 1f\r
 181         nop\r
 182 \r
 183         /* Save the stack pointer. */\r
 184         la                      s6, uxSavedTaskStackPointer\r
 185         sw                      s5, (s6)\r
 186 1:\r
 187         .endm\r
 188 \r
 189 /******************************************************************/\r
 190 .macro  portRESTORE_CONTEXT\r
 191 \r
 192         /* Restore the stack pointer from the TCB.  This is only done if the\r
 193         nesting count is 1. */\r
 194         la                      s6, uxInterruptNesting\r
 195         lw                      s6, (s6)\r
 196         addiu           s6, s6, -1\r
 197         bne                     s6, zero, 1f\r
 198         nop\r
 199         la                      s6, uxSavedTaskStackPointer\r
 200         lw                      s5, (s6)\r
 201 \r
 202         /* Restore the context. */\r
 203 1:      lw                      s6, 128(s5)\r
 204         mthi            s6, $ac1\r
 205         lw                      s6, 124(s5)\r
 206         mtlo            s6, $ac1\r
 207 \r
 208         lw                      s6, 136(s5)\r
 209         mthi            s6, $ac2\r
 210         lw                      s6, 132(s5)\r
 211         mtlo            s6, $ac2\r
 212 \r
 213         lw                      s6, 144(s5)\r
 214         mthi            s6, $ac3\r
 215         lw                      s6, 140(s5)\r
 216         mtlo                    s6, $ac3\r
 217 \r
 218         /* Restore DSPControl. */\r
 219         lw                      s6, 148(s5)\r
 220         wrdsp           s6\r
 221 \r
 222         lw                      s6, 8(s5)\r
 223         mtlo            s6, $ac0\r
 224         lw                      s6, 12(s5)\r
 225         mthi            s6, $ac0\r
 226         lw                      $1, 16(s5)\r
 227 \r
 228         /* s6 is loaded as it was used as a scratch register and therefore saved\r
 229         as part of the interrupt context. */\r
 230         lw                      s6, 44(s5)\r
 231         lw                      v0, 52(s5)\r
 232         lw                      v1, 56(s5)\r
 233         lw                      a0, 60(s5)\r
 234         lw                      a1, 64(s5)\r
 235         lw                      a2, 68(s5)\r
 236         lw                      a3, 72(s5)\r
 237         lw                      t0, 76(s5)\r
 238         lw                      t1, 80(s5)\r
 239         lw                      t2, 84(s5)\r
 240         lw                      t3, 88(s5)\r
 241         lw                      t4, 92(s5)\r
 242         lw                      t5, 96(s5)\r
 243         lw                      t6, 100(s5)\r
 244         lw                      t7, 104(s5)\r
 245         lw                      t8, 108(s5)\r
 246         lw                      t9, 112(s5)\r
 247         lw                      s8, 116(s5)\r
 248         lw                      ra, 120(s5)\r
 249 \r
 250         /* Protect access to the k registers, and others. */\r
 251         di\r
 252         ehb\r
 253 \r
 254         /* Decrement the nesting count. */\r
 255         la                      k0, uxInterruptNesting\r
 256         lw                      k1, (k0)\r
 257         addiu           k1, k1, -1\r
 258         sw                      k1, 0(k0)\r
 259 \r
 260         lw                      k0, portSTATUS_STACK_LOCATION(s5)\r
 261         lw                      k1, portEPC_STACK_LOCATION(s5)\r
 262 \r
 263         /* Leave the stack in its original state.  First load sp from s5, then\r
 264         restore s5 from the stack. */\r
 265         add                     sp, zero, s5\r
 266         lw                      s5, 40(sp)\r
 267         addiu           sp, sp, portCONTEXT_SIZE\r
 268 \r
 269         mtc0            k0, _CP0_STATUS\r
 270         mtc0            k1, _CP0_EPC\r
 271         ehb\r
 272         eret\r
 273         nop\r
 274 \r
 275         .endm\r
 276 \r