]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/MPLAB/PIC32MEC14xx/ISR_Support.h
Update version number ready for the V8.2.3 release.
[freertos] / FreeRTOS / Source / portable / MPLAB / PIC32MEC14xx / ISR_Support.h
1 /*\r
2     FreeRTOS V8.2.3 - 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 132\r
73 #define portEPC_STACK_LOCATION 124\r
74 #define portSTATUS_STACK_LOCATION 128\r
75 \r
76 #ifdef __LANGUAGE_ASSEMBLY__\r
77 \r
78 /******************************************************************/\r
79 .macro  portSAVE_CONTEXT\r
80 \r
81         /* Make room for the context. First save the current status so it can be\r
82         manipulated, and the cause and EPC registers so their original values are\r
83         captured. */\r
84         mfc0    k0, _CP0_CAUSE\r
85         addiu   sp, sp, -portCONTEXT_SIZE\r
86         mfc0    k1, _CP0_STATUS\r
87 \r
88         /* Also save s6 and s5 so they can be used.  Any nesting interrupts should\r
89         maintain the values of these registers across the ISR. */\r
90         sw              s6, 44(sp)\r
91         sw              s5, 40(sp)\r
92         sw              k1, portSTATUS_STACK_LOCATION(sp)\r
93 \r
94         /* Prepare to enable interrupts above the current priority.\r
95         k0 = k0 >> 10. Moves RIPL[17:10] to [7:0] */\r
96         srl             k0, k0, 0xa\r
97 \r
98         /* Insert bit field. 7 bits k0[6:0] to k1[16:10] */\r
99         ins             k1, k0, 10, 7\r
100 \r
101         /* Sets CP0.Status.IPL = CP0.Cause.RIPL\r
102         Copy the MSB of the IPL, but it would be an error if it was set anyway. */\r
103         srl             k0, k0, 0x7\r
104 \r
105         /* MSB of IPL is bit[18] of CP0.Status */\r
106         ins             k1, k0, 18, 1\r
107 \r
108         /* CP0.Status[5:1] = 0 b[5]=Rsvd, b[4]=UM,\r
109            b[3]=Rsvd, b[2]=ERL, b[1]=EXL\r
110            Setting EXL=0 allows higher priority interrupts\r
111            to preempt this handler */\r
112         ins             k1, zero, 1, 4\r
113 \r
114 \r
115         /* s5 is used as the frame pointer. */\r
116         add             s5, zero, sp\r
117 \r
118         /* Check the nesting count value. */\r
119         la              k0, uxInterruptNesting\r
120         lw              s6, (k0)\r
121 \r
122         /* If the nesting count is 0 then swap to the the system stack, otherwise\r
123         the system stack is already being used. */\r
124         bne             s6, zero, 1f\r
125         nop\r
126 \r
127         /* Swap to the system stack. */\r
128         la              sp, xISRStackTop\r
129         lw              sp, (sp)\r
130 \r
131         /* Increment and save the nesting count. */\r
132 1:  addiu   s6, s6, 1\r
133         sw              s6, 0(k0)\r
134 \r
135         /* s6 holds the EPC value, this is saved after interrupts are re-enabled. */\r
136         mfc0    s6, _CP0_EPC\r
137 \r
138         /* Re-enable interrupts. */\r
139         mtc0    k1, _CP0_STATUS\r
140 \r
141         /* Save the context into the space just created.  s6 is saved again\r
142         here as it now contains the EPC value.  No other s registers need be\r
143         saved. */\r
144         sw              ra, 120(s5) /* Return address (RA=R31) */\r
145         sw              s8, 116(s5) /* Frame Pointer (FP=R30) */\r
146         sw              t9, 112(s5)\r
147         sw              t8, 108(s5)\r
148         sw              t7, 104(s5)\r
149         sw              t6, 100(s5)\r
150         sw              t5, 96(s5)\r
151         sw              t4, 92(s5)\r
152         sw              t3, 88(s5)\r
153         sw              t2, 84(s5)\r
154         sw              t1, 80(s5)\r
155         sw              t0, 76(s5)\r
156         sw              a3, 72(s5)\r
157         sw              a2, 68(s5)\r
158         sw              a1, 64(s5)\r
159         sw              a0, 60(s5)\r
160         sw              v1, 56(s5)\r
161         sw              v0, 52(s5)\r
162         sw              s6, portEPC_STACK_LOCATION(s5)\r
163         sw              $1, 16(s5)\r
164 \r
165         /* MEC14xx does not have DSP, removed 7 words */\r
166         mfhi    s6\r
167         sw              s6, 12(s5)\r
168         mflo    s6\r
169         sw              s6, 8(s5)\r
170 \r
171         /* Update the task stack pointer value if nesting is zero. */\r
172         la              s6, uxInterruptNesting\r
173         lw              s6, (s6)\r
174         addiu   s6, s6, -1\r
175         bne             s6, zero, 1f\r
176         nop\r
177 \r
178         /* Save the stack pointer. */\r
179         la              s6, uxSavedTaskStackPointer\r
180         sw              s5, (s6)\r
181 1:\r
182         .endm\r
183 \r
184 /******************************************************************/\r
185 .macro  portRESTORE_CONTEXT\r
186 \r
187         /* Restore the stack pointer from the TCB.  This is only done if the\r
188         nesting count is 1. */\r
189         la              s6, uxInterruptNesting\r
190         lw              s6, (s6)\r
191         addiu   s6, s6, -1\r
192         bne             s6, zero, 1f\r
193         nop\r
194         la              s6, uxSavedTaskStackPointer\r
195         lw              s5, (s6)\r
196 \r
197         /* Restore the context.\r
198         MCHP MEC14xx does not include DSP */\r
199 1:\r
200         lw              s6, 8(s5)\r
201         mtlo    s6\r
202         lw              s6, 12(s5)\r
203         mthi    s6\r
204         lw              $1, 16(s5)\r
205 \r
206         /* s6 is loaded as it was used as a scratch register and therefore saved\r
207         as part of the interrupt context. */\r
208         lw              s6, 44(s5)\r
209         lw              v0, 52(s5)\r
210         lw              v1, 56(s5)\r
211         lw              a0, 60(s5)\r
212         lw              a1, 64(s5)\r
213         lw              a2, 68(s5)\r
214         lw              a3, 72(s5)\r
215         lw              t0, 76(s5)\r
216         lw              t1, 80(s5)\r
217         lw              t2, 84(s5)\r
218         lw              t3, 88(s5)\r
219         lw              t4, 92(s5)\r
220         lw              t5, 96(s5)\r
221         lw              t6, 100(s5)\r
222         lw              t7, 104(s5)\r
223         lw              t8, 108(s5)\r
224         lw              t9, 112(s5)\r
225         lw              s8, 116(s5)\r
226         lw              ra, 120(s5)\r
227 \r
228         /* Protect access to the k registers, and others. */\r
229         di\r
230         ehb\r
231 \r
232         /* Decrement the nesting count. */\r
233         la              k0, uxInterruptNesting\r
234         lw              k1, (k0)\r
235         addiu   k1, k1, -1\r
236         sw              k1, 0(k0)\r
237 \r
238         lw              k0, portSTATUS_STACK_LOCATION(s5)\r
239         lw              k1, portEPC_STACK_LOCATION(s5)\r
240 \r
241         /* Leave the stack in its original state.  First load sp from s5, then\r
242         restore s5 from the stack. */\r
243         add             sp, zero, s5\r
244         lw              s5, 40(sp)\r
245         addiu   sp, sp, portCONTEXT_SIZE\r
246 \r
247         mtc0    k0, _CP0_STATUS\r
248         mtc0    k1, _CP0_EPC\r
249         ehb\r
250         eret\r
251         nop\r
252 \r
253         .endm\r
254 \r
255 #endif /* #ifdef __LANGUAGE_ASSEMBLY__ */\r
256 \r