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

   1 /*\r
   2     FreeRTOS V8.2.0rc1 - Copyright (C) 2014 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     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
  14     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
  15     >>!   obliged to provide the source code for proprietary components     !<<\r
  16     >>!   outside of the FreeRTOS kernel.                                   !<<\r
  17 \r
  18     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  19     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  20     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
  21     link: http://www.freertos.org/a00114.html\r
  22 \r
  23     1 tab == 4 spaces!\r
  24 \r
  25     ***************************************************************************\r
  26      *                                                                       *\r
  27      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  28      *    not run, what could be wrong?".  Have you defined configASSERT()?  *\r
  29      *                                                                       *\r
  30      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  31      *                                                                       *\r
  32     ***************************************************************************\r
  33 \r
  34     ***************************************************************************\r
  35      *                                                                       *\r
  36      *    FreeRTOS provides completely free yet professionally developed,    *\r
  37      *    robust, strictly quality controlled, supported, and cross          *\r
  38      *    platform software that is more than just the market leader, it     *\r
  39      *    is the industry's de facto standard.                               *\r
  40      *                                                                       *\r
  41      *    Help yourself get started quickly while simultaneously helping     *\r
  42      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
  43      *    tutorial book, reference manual, or both:                          *\r
  44      *    http://www.FreeRTOS.org/Documentation                              *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     ***************************************************************************\r
  49      *                                                                       *\r
  50      *   Investing in training allows your team to be as productive as       *\r
  51      *   possible as early as possible, lowering your overall development    *\r
  52      *   cost, and enabling you to bring a more robust product to market     *\r
  53      *   earlier than would otherwise be possible.  Richard Barry is both    *\r
  54      *   the architect and key author of FreeRTOS, and so also the world's   *\r
  55      *   leading authority on what is the world's most popular real time     *\r
  56      *   kernel for deeply embedded MCU designs.  Obtaining your training    *\r
  57      *   from Richard ensures your team will gain directly from his in-depth *\r
  58      *   product knowledge and years of usage experience.  Contact Real Time *\r
  59      *   Engineers Ltd to enquire about the FreeRTOS Masterclass, presented  *\r
  60      *   by Richard Barry:  http://www.FreeRTOS.org/contact\r
  61      *                                                                       *\r
  62     ***************************************************************************\r
  63 \r
  64     ***************************************************************************\r
  65      *                                                                       *\r
  66      *    You are receiving this top quality software for free.  Please play *\r
  67      *    fair and reciprocate by reporting any suspected issues and         *\r
  68      *    participating in the community forum:                              *\r
  69      *    http://www.FreeRTOS.org/support                                    *\r
  70      *                                                                       *\r
  71      *    Thank you!                                                         *\r
  72      *                                                                       *\r
  73     ***************************************************************************\r
  74 \r
  75     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  76     license and Real Time Engineers Ltd. contact details.\r
  77 \r
  78     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  79     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  80     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  81 \r
  82     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
  83     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
  84 \r
  85     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  86     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  87     licenses offer ticketed support, indemnification and commercial middleware.\r
  88 \r
  89     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  90     engineered and independently SIL3 certified version for use in safety and\r
  91     mission critical applications that require provable dependability.\r
  92 \r
  93     1 tab == 4 spaces!\r
  94 */\r
  95 \r
  96 #include "FreeRTOSConfig.h"\r
  97 \r
  98 #define portCONTEXT_SIZE 160\r
  99 #define portEPC_STACK_LOCATION 152\r
 100 #define portSTATUS_STACK_LOCATION 156\r
 101 \r
 102 /******************************************************************/\r
 103 .macro  portSAVE_CONTEXT\r
 104 \r
 105         /* Make room for the context. First save the current status so it can be\r
 106         manipulated, and the cause and EPC registers so their original values are\r
 107         captured. */\r
 108         mfc0            k0, _CP0_CAUSE\r
 109         addiu           sp, sp, -portCONTEXT_SIZE\r
 110         mfc0            k1, _CP0_STATUS\r
 111 \r
 112         /* Also save s6 and s5 so they can be used.  Any nesting interrupts should\r
 113         maintain the values of these registers across the ISR. */\r
 114         sw                      s6, 44(sp)\r
 115         sw                      s5, 40(sp)\r
 116         sw                      k1, portSTATUS_STACK_LOCATION(sp)\r
 117 \r
 118         /* Prepare to enable interrupts above the current priority. */\r
 119         srl                     k0, k0, 0xa\r
 120         ins             k1, k0, 10, 7\r
 121         srl                     k0, k0, 0x7 /* This copies the MSB of the IPL, but it would be an error if it was set anyway. */\r
 122         ins             k1, k0, 18, 1\r
 123         ins                     k1, zero, 1, 4\r
 124 \r
 125         /* s5 is used as the frame pointer. */\r
 126         add                     s5, zero, sp\r
 127 \r
 128         /* Check the nesting count value. */\r
 129         la                      k0, uxInterruptNesting\r
 130         lw                      s6, (k0)\r
 131 \r
 132         /* If the nesting count is 0 then swap to the the system stack, otherwise\r
 133         the system stack is already being used. */\r
 134         bne                     s6, zero, 1f\r
 135         nop\r
 136 \r
 137         /* Swap to the system stack. */\r
 138         la                      sp, xISRStackTop\r
 139         lw                      sp, (sp)\r
 140 \r
 141         /* Increment and save the nesting count. */\r
 142 1:      addiu           s6, s6, 1\r
 143         sw                      s6, 0(k0)\r
 144 \r
 145         /* s6 holds the EPC value, this is saved after interrupts are re-enabled. */\r
 146         mfc0            s6, _CP0_EPC\r
 147 \r
 148         /* Re-enable interrupts. */\r
 149         mtc0            k1, _CP0_STATUS\r
 150 \r
 151         /* Save the context into the space just created.  s6 is saved again\r
 152         here as it now contains the EPC value.  No other s registers need be\r
 153         saved. */\r
 154         sw                      ra, 120(s5)\r
 155         sw                      s8, 116(s5)\r
 156         sw                      t9, 112(s5)\r
 157         sw                      t8, 108(s5)\r
 158         sw                      t7, 104(s5)\r
 159         sw                      t6, 100(s5)\r
 160         sw                      t5, 96(s5)\r
 161         sw                      t4, 92(s5)\r
 162         sw                      t3, 88(s5)\r
 163         sw                      t2, 84(s5)\r
 164         sw                      t1, 80(s5)\r
 165         sw                      t0, 76(s5)\r
 166         sw                      a3, 72(s5)\r
 167         sw                      a2, 68(s5)\r
 168         sw                      a1, 64(s5)\r
 169         sw                      a0, 60(s5)\r
 170         sw                      v1, 56(s5)\r
 171         sw                      v0, 52(s5)\r
 172         sw                      s6, portEPC_STACK_LOCATION(s5)\r
 173         sw                      $1, 16(s5)\r
 174 \r
 175         /* Save the AC0, AC1, AC2, AC3 registers from the DSP.  s6 is used as a\r
 176         scratch register. */\r
 177         mfhi            s6, $ac1\r
 178         sw                      s6, 128(s5)\r
 179         mflo            s6, $ac1\r
 180         sw                      s6, 124(s5)\r
 181 \r
 182         mfhi            s6, $ac2\r
 183         sw                      s6, 136(s5)\r
 184         mflo            s6, $ac2\r
 185         sw                      s6, 132(s5)\r
 186 \r
 187         mfhi            s6, $ac3\r
 188         sw                      s6, 144(s5)\r
 189         mflo            s6, $ac3\r
 190         sw                      s6, 140(s5)\r
 191 \r
 192         /* Save the DSP Control register */\r
 193         rddsp           s6\r
 194         sw                      s6, 148(s5)\r
 195 \r
 196         /* ac0 is done separately to match the MX port. */\r
 197         mfhi            s6, $ac0\r
 198         sw                      s6, 12(s5)\r
 199         mflo            s6, $ac0\r
 200         sw                      s6, 8(s5)\r
 201 \r
 202         /* Update the task stack pointer value if nesting is zero. */\r
 203         la                      s6, uxInterruptNesting\r
 204         lw                      s6, (s6)\r
 205         addiu           s6, s6, -1\r
 206         bne                     s6, zero, 1f\r
 207         nop\r
 208 \r
 209         /* Save the stack pointer. */\r
 210         la                      s6, uxSavedTaskStackPointer\r
 211         sw                      s5, (s6)\r
 212 1:\r
 213         .endm\r
 214 \r
 215 /******************************************************************/\r
 216 .macro  portRESTORE_CONTEXT\r
 217 \r
 218         /* Restore the stack pointer from the TCB.  This is only done if the\r
 219         nesting count is 1. */\r
 220         la                      s6, uxInterruptNesting\r
 221         lw                      s6, (s6)\r
 222         addiu           s6, s6, -1\r
 223         bne                     s6, zero, 1f\r
 224         nop\r
 225         la                      s6, uxSavedTaskStackPointer\r
 226         lw                      s5, (s6)\r
 227 \r
 228         /* Restore the context. */\r
 229 1:      lw                      s6, 128(s5)\r
 230         mthi            s6, $ac1\r
 231         lw                      s6, 124(s5)\r
 232         mtlo            s6, $ac1\r
 233 \r
 234         lw                      s6, 136(s5)\r
 235         mthi            s6, $ac2\r
 236         lw                      s6, 132(s5)\r
 237         mtlo            s6, $ac2\r
 238 \r
 239         lw                      s6, 144(s5)\r
 240         mthi            s6, $ac3\r
 241         lw                      s6, 140(s5)\r
 242         mtlo                    s6, $ac3\r
 243 \r
 244         /* Restore DSPControl. */\r
 245         lw                      s6, 148(s5)\r
 246         wrdsp           s6\r
 247 \r
 248         lw                      s6, 8(s5)\r
 249         mtlo            s6, $ac0\r
 250         lw                      s6, 12(s5)\r
 251         mthi            s6, $ac0\r
 252         lw                      $1, 16(s5)\r
 253 \r
 254         /* s6 is loaded as it was used as a scratch register and therefore saved\r
 255         as part of the interrupt context. */\r
 256         lw                      s6, 44(s5)\r
 257         lw                      v0, 52(s5)\r
 258         lw                      v1, 56(s5)\r
 259         lw                      a0, 60(s5)\r
 260         lw                      a1, 64(s5)\r
 261         lw                      a2, 68(s5)\r
 262         lw                      a3, 72(s5)\r
 263         lw                      t0, 76(s5)\r
 264         lw                      t1, 80(s5)\r
 265         lw                      t2, 84(s5)\r
 266         lw                      t3, 88(s5)\r
 267         lw                      t4, 92(s5)\r
 268         lw                      t5, 96(s5)\r
 269         lw                      t6, 100(s5)\r
 270         lw                      t7, 104(s5)\r
 271         lw                      t8, 108(s5)\r
 272         lw                      t9, 112(s5)\r
 273         lw                      s8, 116(s5)\r
 274         lw                      ra, 120(s5)\r
 275 \r
 276         /* Protect access to the k registers, and others. */\r
 277         di\r
 278         ehb\r
 279 \r
 280         /* Decrement the nesting count. */\r
 281         la                      k0, uxInterruptNesting\r
 282         lw                      k1, (k0)\r
 283         addiu           k1, k1, -1\r
 284         sw                      k1, 0(k0)\r
 285 \r
 286         lw                      k0, portSTATUS_STACK_LOCATION(s5)\r
 287         lw                      k1, portEPC_STACK_LOCATION(s5)\r
 288 \r
 289         /* Leave the stack in its original state.  First load sp from s5, then\r
 290         restore s5 from the stack. */\r
 291         add                     sp, zero, s5\r
 292         lw                      s5, 40(sp)\r
 293         addiu           sp, sp, portCONTEXT_SIZE\r
 294 \r
 295         mtc0            k0, _CP0_STATUS\r
 296         mtc0            k1, _CP0_EPC\r
 297         ehb\r
 298         eret\r
 299         nop\r
 300 \r
 301         .endm\r
 302 \r