]> begriffs open source - freertos/blob - portable/Renesas/RX600/port.c
[AUTO][RELEASE]: Bump file header version to "10.5.0"
[freertos] / portable / Renesas / RX600 / port.c
1 /*\r
2  * FreeRTOS Kernel V10.5.0\r
3  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
4  *\r
5  * SPDX-License-Identifier: MIT\r
6  *\r
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
8  * this software and associated documentation files (the "Software"), to deal in\r
9  * the Software without restriction, including without limitation the rights to\r
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
11  * the Software, and to permit persons to whom the Software is furnished to do so,\r
12  * subject to the following conditions:\r
13  *\r
14  * The above copyright notice and this permission notice shall be included in all\r
15  * copies or substantial portions of the Software.\r
16  *\r
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
23  *\r
24  * https://www.FreeRTOS.org\r
25  * https://github.com/FreeRTOS\r
26  *\r
27  */\r
28 \r
29 /*-----------------------------------------------------------\r
30  * Implementation of functions defined in portable.h for the RX600 port.\r
31  *----------------------------------------------------------*/\r
32 \r
33 /* Scheduler includes. */\r
34 #include "FreeRTOS.h"\r
35 #include "task.h"\r
36 \r
37 /* Library includes. */\r
38 #include "string.h"\r
39 \r
40 /* Hardware specifics. */\r
41 #include "iodefine.h"\r
42 \r
43 /*-----------------------------------------------------------*/\r
44 \r
45 /* Tasks should start with interrupts enabled and in Supervisor mode, therefore\r
46 PSW is set with U and I set, and PM and IPL clear. */\r
47 #define portINITIAL_PSW     ( ( StackType_t ) 0x00030000 )\r
48 #define portINITIAL_FPSW    ( ( StackType_t ) 0x00000100 )\r
49 \r
50 /*-----------------------------------------------------------*/\r
51 \r
52 /* The following lines are to ensure vSoftwareInterruptEntry can be referenced,\r
53  and therefore installed in the vector table, when the FreeRTOS code is built\r
54 as a library. */\r
55 extern BaseType_t vSoftwareInterruptEntry;\r
56 const BaseType_t * p_vSoftwareInterruptEntry = &vSoftwareInterruptEntry;\r
57 \r
58 /*-----------------------------------------------------------*/\r
59 \r
60 /*\r
61  * Function to start the first task executing - written in asm code as direct\r
62  * access to registers is required.\r
63  */\r
64 static void prvStartFirstTask( void );\r
65 \r
66 /*\r
67  * Software interrupt handler.  Performs the actual context switch (saving and\r
68  * restoring of registers).  Written in asm code as direct register access is\r
69  * required.\r
70  */\r
71 static void prvYieldHandler( void );\r
72 \r
73 /*\r
74  * The entry point for the software interrupt handler.  This is the function\r
75  * that calls the inline asm function prvYieldHandler().  It is installed in\r
76  * the vector table, but the code that installs it is in prvYieldHandler rather\r
77  * than using a #pragma.\r
78  */\r
79 void vSoftwareInterruptISR( void );\r
80 \r
81 /*-----------------------------------------------------------*/\r
82 \r
83 /* This is accessed by the inline assembler functions so is file scope for\r
84 convenience. */\r
85 extern void *pxCurrentTCB;\r
86 extern void vTaskSwitchContext( void );\r
87 \r
88 /*-----------------------------------------------------------*/\r
89 \r
90 /*\r
91  * See header file for description.\r
92  */\r
93 StackType_t *pxPortInitialiseStack( StackType_t *pxTopOfStack, TaskFunction_t pxCode, void *pvParameters )\r
94 {\r
95         /* R0 is not included as it is the stack pointer. */\r
96 \r
97         *pxTopOfStack = 0x00;\r
98         pxTopOfStack--;\r
99         *pxTopOfStack = portINITIAL_PSW;\r
100         pxTopOfStack--;\r
101         *pxTopOfStack = ( StackType_t ) pxCode;\r
102 \r
103         /* When debugging it can be useful if every register is set to a known\r
104         value.  Otherwise code space can be saved by just setting the registers\r
105         that need to be set. */\r
106         #ifdef USE_FULL_REGISTER_INITIALISATION\r
107         {\r
108                 pxTopOfStack--;\r
109                 *pxTopOfStack = 0xffffffff;     /* r15. */\r
110                 pxTopOfStack--;\r
111                 *pxTopOfStack = 0xeeeeeeee;\r
112                 pxTopOfStack--;\r
113                 *pxTopOfStack = 0xdddddddd;\r
114                 pxTopOfStack--;\r
115                 *pxTopOfStack = 0xcccccccc;\r
116                 pxTopOfStack--;\r
117                 *pxTopOfStack = 0xbbbbbbbb;\r
118                 pxTopOfStack--;\r
119                 *pxTopOfStack = 0xaaaaaaaa;\r
120                 pxTopOfStack--;\r
121                 *pxTopOfStack = 0x99999999;\r
122                 pxTopOfStack--;\r
123                 *pxTopOfStack = 0x88888888;\r
124                 pxTopOfStack--;\r
125                 *pxTopOfStack = 0x77777777;\r
126                 pxTopOfStack--;\r
127                 *pxTopOfStack = 0x66666666;\r
128                 pxTopOfStack--;\r
129                 *pxTopOfStack = 0x55555555;\r
130                 pxTopOfStack--;\r
131                 *pxTopOfStack = 0x44444444;\r
132                 pxTopOfStack--;\r
133                 *pxTopOfStack = 0x33333333;\r
134                 pxTopOfStack--;\r
135                 *pxTopOfStack = 0x22222222;\r
136                 pxTopOfStack--;\r
137         }\r
138         #else\r
139         {\r
140                 pxTopOfStack -= 15;\r
141         }\r
142         #endif\r
143 \r
144         *pxTopOfStack = ( StackType_t ) pvParameters; /* R1 */\r
145         pxTopOfStack--;\r
146         *pxTopOfStack = portINITIAL_FPSW;\r
147         pxTopOfStack--;\r
148         *pxTopOfStack = 0x12345678; /* Accumulator. */\r
149         pxTopOfStack--;\r
150         *pxTopOfStack = 0x87654321; /* Accumulator. */\r
151 \r
152         return pxTopOfStack;\r
153 }\r
154 /*-----------------------------------------------------------*/\r
155 \r
156 BaseType_t xPortStartScheduler( void )\r
157 {\r
158 extern void vApplicationSetupTimerInterrupt( void );\r
159 \r
160         /* Use pxCurrentTCB just so it does not get optimised away. */\r
161         if( pxCurrentTCB != NULL )\r
162         {\r
163                 /* Call an application function to set up the timer that will generate the\r
164                 tick interrupt.  This way the application can decide which peripheral to\r
165                 use.  A demo application is provided to show a suitable example. */\r
166                 vApplicationSetupTimerInterrupt();\r
167 \r
168                 /* Enable the software interrupt. */\r
169                 _IEN( _ICU_SWINT ) = 1;\r
170 \r
171                 /* Ensure the software interrupt is clear. */\r
172                 _IR( _ICU_SWINT ) = 0;\r
173 \r
174                 /* Ensure the software interrupt is set to the kernel priority. */\r
175                 _IPR( _ICU_SWINT ) = configKERNEL_INTERRUPT_PRIORITY;\r
176 \r
177                 /* Start the first task. */\r
178                 prvStartFirstTask();\r
179         }\r
180 \r
181         /* Just to make sure the function is not optimised away. */\r
182         ( void ) vSoftwareInterruptISR();\r
183 \r
184         /* Should not get here. */\r
185         return pdFAIL;\r
186 }\r
187 /*-----------------------------------------------------------*/\r
188 \r
189 #pragma inline_asm prvStartFirstTask\r
190 static void prvStartFirstTask( void )\r
191 {\r
192         /* When starting the scheduler there is nothing that needs moving to the\r
193         interrupt stack because the function is not called from an interrupt.\r
194         Just ensure the current stack is the user stack. */\r
195         SETPSW  U\r
196 \r
197         /* Obtain the location of the stack associated with which ever task\r
198         pxCurrentTCB is currently pointing to. */\r
199         MOV.L   #_pxCurrentTCB, R15\r
200         MOV.L   [R15], R15\r
201         MOV.L   [R15], R0\r
202 \r
203         /* Restore the registers from the stack of the task pointed to by\r
204         pxCurrentTCB. */\r
205     POP         R15\r
206     MVTACLO     R15             /* Accumulator low 32 bits. */\r
207     POP         R15\r
208     MVTACHI     R15             /* Accumulator high 32 bits. */\r
209     POP         R15\r
210     MVTC        R15,FPSW        /* Floating point status word. */\r
211     POPM        R1-R15          /* R1 to R15 - R0 is not included as it is the SP. */\r
212     RTE                                 /* This pops the remaining registers. */\r
213     NOP\r
214     NOP\r
215 }\r
216 /*-----------------------------------------------------------*/\r
217 \r
218 #pragma interrupt ( vTickISR( vect = _VECT( configTICK_VECTOR ), enable ) )\r
219 void vTickISR( void )\r
220 {\r
221         /* Increment the tick, and perform any processing the new tick value\r
222         necessitates. */\r
223         set_ipl( configMAX_SYSCALL_INTERRUPT_PRIORITY );\r
224         {\r
225                 if( xTaskIncrementTick() != pdFALSE )\r
226                 {\r
227                         taskYIELD();\r
228                 }\r
229         }\r
230         set_ipl( configKERNEL_INTERRUPT_PRIORITY );\r
231 }\r
232 /*-----------------------------------------------------------*/\r
233 \r
234 void vSoftwareInterruptISR( void )\r
235 {\r
236         prvYieldHandler();\r
237 }\r
238 /*-----------------------------------------------------------*/\r
239 \r
240 #pragma inline_asm prvYieldHandler\r
241 static void prvYieldHandler( void )\r
242 {\r
243         /* Re-enable interrupts. */\r
244         SETPSW  I\r
245 \r
246         /* Move the data that was automatically pushed onto the interrupt stack when\r
247         the interrupt occurred from the interrupt stack to the user stack.\r
248 \r
249         R15 is saved before it is clobbered. */\r
250         PUSH.L  R15\r
251 \r
252         /* Read the user stack pointer. */\r
253         MVFC    USP, R15\r
254 \r
255         /* Move the address down to the data being moved. */\r
256         SUB             #12, R15\r
257         MVTC    R15, USP\r
258 \r
259         /* Copy the data across. */\r
260         MOV.L   [ R0 ], [ R15 ] ; R15\r
261         MOV.L   4[ R0 ], 4[ R15 ]  ; PC\r
262         MOV.L   8[ R0 ], 8[ R15 ]  ; PSW\r
263 \r
264         /* Move the interrupt stack pointer to its new correct position. */\r
265         ADD     #12, R0\r
266 \r
267         /* All the rest of the registers are saved directly to the user stack. */\r
268         SETPSW  U\r
269 \r
270         /* Save the rest of the general registers (R15 has been saved already). */\r
271         PUSHM   R1-R14\r
272 \r
273         /* Save the FPSW and accumulator. */\r
274         MVFC    FPSW, R15\r
275         PUSH.L  R15\r
276         MVFACHI R15\r
277         PUSH.L  R15\r
278         MVFACMI R15     ; Middle order word.\r
279         SHLL    #16, R15 ; Shifted left as it is restored to the low order word.\r
280         PUSH.L  R15\r
281 \r
282         /* Save the stack pointer to the TCB. */\r
283         MOV.L   #_pxCurrentTCB, R15\r
284         MOV.L   [ R15 ], R15\r
285         MOV.L   R0, [ R15 ]\r
286 \r
287         /* Ensure the interrupt mask is set to the syscall priority while the kernel\r
288         structures are being accessed. */\r
289         MVTIPL  #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
290 \r
291         /* Select the next task to run. */\r
292         BSR.A   _vTaskSwitchContext\r
293 \r
294         /* Reset the interrupt mask as no more data structure access is required. */\r
295         MVTIPL  #configKERNEL_INTERRUPT_PRIORITY\r
296 \r
297         /* Load the stack pointer of the task that is now selected as the Running\r
298         state task from its TCB. */\r
299         MOV.L   #_pxCurrentTCB,R15\r
300         MOV.L   [ R15 ], R15\r
301         MOV.L   [ R15 ], R0\r
302 \r
303         /* Restore the context of the new task.  The PSW (Program Status Word) and\r
304         PC will be popped by the RTE instruction. */\r
305         POP             R15\r
306         MVTACLO R15\r
307         POP             R15\r
308         MVTACHI R15\r
309         POP             R15\r
310         MVTC    R15,FPSW\r
311         POPM    R1-R15\r
312         RTE\r
313         NOP\r
314         NOP\r
315 }\r
316 /*-----------------------------------------------------------*/\r
317 \r
318 void vPortEndScheduler( void )\r
319 {\r
320         /* Not implemented in ports where there is nothing to return to.\r
321         Artificially force an assert. */\r
322         configASSERT( pxCurrentTCB == NULL );\r
323 \r
324         /* The following line is just to prevent the symbol getting optimised away. */\r
325         ( void ) vTaskSwitchContext();\r
326 }\r
327 /*-----------------------------------------------------------*/\r
328 \r
329 \r
330 \r