Further Cortex-M3 core related macros.
[bertos.git] / bertos / cpu / frame.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2008 Bernie Innocenti <bernie@codewiz.org>
30  * Copyright 2004, 2005, 2006, 2007, 2008 Develer S.r.l. (http://www.develer.com/)
31  * Copyright 2004 Giovanni Bajo
32  *
33  * -->
34  *
35  * \brief CPU-specific stack frame handling macros.
36  *
37  * These are mainly used by the portable part of the scheduler
38  * to work with the process stack frames.
39  *
40  * \author Giovanni Bajo <rasky@develer.com>
41  * \author Bernie Innocenti <bernie@codewiz.org>
42  * \author Stefano Fedrigo <aleph@develer.com>
43  * \author Francesco Sacchi <batt@develer.com>
44  */
45 #ifndef CPU_FRAME_H
46 #define CPU_FRAME_H
47
48 #include <cpu/detect.h>
49
50 #include "cfg/cfg_arch.h"      /* ARCH_EMUL */
51 #include <cfg/compiler.h>      /* for uintXX_t */
52
53 #if CPU_X86
54         #if CPU_X86_32
55                 #define CPU_SAVED_REGS_CNT      2
56         #elif CPU_X86_64
57                 #define CPU_SAVED_REGS_CNT      8
58         #else
59                 #error "unknown CPU"
60         #endif
61         #define CPU_STACK_GROWS_UPWARD  0
62         #define CPU_SP_ON_EMPTY_SLOT    0
63
64 #elif CPU_ARM
65
66         #define CPU_SAVED_REGS_CNT     8
67         #define CPU_STACK_GROWS_UPWARD 0
68         #define CPU_SP_ON_EMPTY_SLOT   0
69
70 #elif CPU_CM3
71
72         #define CPU_SAVED_REGS_CNT     fixme
73         #define CPU_STACK_GROWS_UPWARD 0
74         #define CPU_SP_ON_EMPTY_SLOT   0
75
76 #elif CPU_PPC
77
78         #define CPU_SAVED_REGS_CNT     1
79         #define CPU_STACK_GROWS_UPWARD 0
80         #define CPU_SP_ON_EMPTY_SLOT   1
81
82 #elif CPU_DSP56K
83
84         #define CPU_SAVED_REGS_CNT      8
85         #define CPU_STACK_GROWS_UPWARD  1
86         #define CPU_SP_ON_EMPTY_SLOT    0
87
88 #elif CPU_AVR
89
90         #define CPU_SAVED_REGS_CNT     18
91         #define CPU_STACK_GROWS_UPWARD  0
92         #define CPU_SP_ON_EMPTY_SLOT    1
93
94 #else
95         #error No CPU_... defined.
96 #endif
97
98 #ifndef CPU_STACK_GROWS_UPWARD
99         #error CPU_STACK_GROWS_UPWARD should have been defined to either 0 or 1
100 #endif
101
102 #ifndef CPU_SP_ON_EMPTY_SLOT
103         #error CPU_SP_ON_EMPTY_SLOT should have been defined to either 0 or 1
104 #endif
105
106 /// Default for macro not defined in the right arch section
107 #ifndef CPU_REG_INIT_VALUE
108         #define CPU_REG_INIT_VALUE(reg)     (reg)
109 #endif
110
111 /*
112  * Support stack handling peculiarities of a few CPUs.
113  *
114  * Most processors let their stack grow downward and
115  * keep SP pointing at the last pushed value.
116  */
117 #if !CPU_STACK_GROWS_UPWARD
118         #if !CPU_SP_ON_EMPTY_SLOT
119                 /* Most microprocessors (x86, m68k...) */
120                 #define CPU_PUSH_WORD(sp, data) \
121                         do { *--(sp) = (data); } while (0)
122                 #define CPU_POP_WORD(sp) \
123                         (*(sp)++)
124         #else
125                 /* AVR insanity */
126                 #define CPU_PUSH_WORD(sp, data) \
127                         do { *(sp)-- = (data); } while (0)
128                 #define CPU_POP_WORD(sp) \
129                         (*++(sp))
130         #endif
131
132 #else /* CPU_STACK_GROWS_UPWARD */
133
134         #if !CPU_SP_ON_EMPTY_SLOT
135                 /* DSP56K and other weirdos */
136                 #define CPU_PUSH_WORD(sp, data) \
137                         do { *++(sp) = (cpu_stack_t)(data); } while (0)
138                 #define CPU_POP_WORD(sp) \
139                         (*(sp)--)
140         #else
141                 #error I bet you cannot find a CPU like this
142         #endif
143 #endif
144
145
146 #if CPU_DSP56K
147         /*
148          * DSP56k pushes both PC and SR to the stack in the JSR instruction, but
149          * RTS discards SR while returning (it does not restore it). So we push
150          * 0 to fake the same context.
151          */
152         #define CPU_PUSH_CALL_FRAME(sp, func) \
153                 do { \
154                         CPU_PUSH_WORD((sp), (func)); \
155                         CPU_PUSH_WORD((sp), 0x100); \
156                 } while (0);
157
158 #elif CPU_AVR
159         /*
160          * On AVR, addresses are pushed into the stack as little-endian, while
161          * memory accesses are big-endian (actually, it's a 8-bit CPU, so there is
162          * no natural endianess).
163          */
164         #define CPU_PUSH_CALL_FRAME(sp, func) \
165                 do { \
166                         uint16_t funcaddr = (uint16_t)(func); \
167                         CPU_PUSH_WORD((sp), funcaddr); \
168                         CPU_PUSH_WORD((sp), funcaddr>>8); \
169                 } while (0)
170
171         /*
172          * If the kernel is in idle-spinning, the processor executes:
173          *
174          * IRQ_ENABLE;
175          * CPU_IDLE;
176          * IRQ_DISABLE;
177          *
178          * IRQ_ENABLE is translated in asm as "sei" and IRQ_DISABLE as "cli".
179          * We could define CPU_IDLE to expand to none, so the resulting
180          * asm code would be:
181          *
182          * sei;
183          * cli;
184          *
185          * But Atmel datasheet states:
186          * "When using the SEI instruction to enable interrupts,
187          * the instruction following SEI will be executed *before*
188          * any pending interrupts", so "cli" is executed before any
189          * pending interrupt with the result that IRQs will *NOT*
190          * be enabled!
191          * To ensure that IRQ will run a NOP is required.
192          */
193         #define CPU_IDLE NOP
194
195 #elif CPU_PPC
196
197         #define CPU_PUSH_CALL_FRAME(sp, func) \
198                 do { \
199                         CPU_PUSH_WORD((sp), (cpu_stack_t)(func)); /* LR -> 8(SP) */ \
200                         CPU_PUSH_WORD((sp), 0);                  /* CR -> 4(SP) */ \
201                 } while (0)
202
203 #else
204         #define CPU_PUSH_CALL_FRAME(sp, func) \
205                 CPU_PUSH_WORD((sp), (cpu_stack_t)(func))
206 #endif
207
208 /**
209  * \def CPU_IDLE
210  *
211  * \brief Invoked by the scheduler to stop the CPU when idle.
212  *
213  * This hook can be redefined to put the CPU in low-power mode, or to
214  * profile system load with an external strobe, or to save CPU cycles
215  * in hosted environments such as emulators.
216  */
217 #ifndef CPU_IDLE
218         #define CPU_IDLE PAUSE
219 #endif /* !CPU_IDLE */
220
221 /**
222  * Default macro for creating a new Process stack
223  */
224 #ifndef CPU_CREATE_NEW_STACK
225
226         #define CPU_CREATE_NEW_STACK(stack) \
227                 do { \
228                         size_t i; \
229                         /* Initialize process stack frame */ \
230                         CPU_PUSH_CALL_FRAME(stack, proc_entry); \
231                         /* Push a clean set of CPU registers for asm_switch_context() */ \
232                         for (i = 0; i < CPU_SAVED_REGS_CNT; i++) \
233                                 CPU_PUSH_WORD(stack, CPU_REG_INIT_VALUE(i)); \
234                 } while (0)
235 #endif
236
237 #endif /* CPU_ATTR_H */