Task switching con salvataggio perfetto stato di interrupt (SR)
[bertos.git] / cpu.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 2004 Giovanni Bajo
6  * This file is part of DevLib - See devlib/README for information.
7  * -->
8  *
9  * \brief CPU-specific definitions
10  *
11  * \version $Id$
12  *
13  * \author Giovanni Bajo <rasky@develer.com>
14  * \author Bernardo Innocenti <bernie@develer.com>
15  * \author Stefano Fedrigo <aleph@develer.com>
16  */
17
18 /*
19  * $Log$
20  * Revision 1.9  2004/07/30 14:24:16  rasky
21  * Task switching con salvataggio perfetto stato di interrupt (SR)
22  * Kernel monitor per dump informazioni su stack dei processi
23  *
24  * Revision 1.8  2004/07/30 14:15:53  rasky
25  * Nuovo supporto unificato per detect della CPU
26  *
27  * Revision 1.7  2004/07/20 23:26:48  bernie
28  * Fix two errors introduced by previous commit.
29  *
30  * Revision 1.6  2004/07/20 23:12:16  bernie
31  * Rationalize and document SCHEDULER_IDLE.
32  *
33  * Revision 1.5  2004/07/20 16:20:35  bernie
34  * Move byte-order macros to mware/byteorder.h; Add missing author names.
35  *
36  * Revision 1.4  2004/07/20 16:06:04  bernie
37  * Add macros to handle endianess issues.
38  *
39  * Revision 1.3  2004/07/18 21:49:51  bernie
40  * Fixes for GCC 3.5.
41  *
42  * Revision 1.2  2004/06/03 11:27:09  bernie
43  * Add dual-license information.
44  *
45  * Revision 1.1  2004/05/23 17:48:35  bernie
46  * Add top-level files.
47  *
48  */
49 #ifndef CPU_H
50 #define CPU_H
51
52 #include "compiler.h"
53
54
55 //! Initialization value for registers in stack frame
56 #define CPU_REG_INIT_VALUE(reg)     0
57
58 // Macros for determining CPU endianess
59 #define CPU_BIG_ENDIAN    0x1234
60 #define CPU_LITTLE_ENDIAN 0x3412
61
62 // Macros to include cpu-specific version of the headers
63 #define CPU_HEADER(module)          PP_STRINGIZE(PP_CAT4(module, _, CPU_ID, .h))
64
65
66 #if CPU_I196
67
68         #define DISABLE_INTS            disable_interrupt()
69         #define ENABLE_INTS             enable_interrupt()
70         #define NOP                     nop_instruction()
71
72         typedef uint16_t cpuflags_t; // FIXME
73         typedef unsigned int cpustack_t;
74
75         #define CPU_REGS_CNT            16
76         #define CPU_STACK_GROWS_UPWARD  0
77         #define CPU_SP_ON_EMPTY_SLOT    0
78         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
79
80 #elif CPU_X86
81
82         #define NOP                     asm volatile ("nop")
83         #define DISABLE_INTS            /* nothing */
84         #define ENABLE_INTS             /* nothing */
85
86         typedef uint32_t cpuflags_t; // FIXME
87         typedef uint32_t cpustack_t;
88
89         #define CPU_REGS_CNT            7
90         #define CPU_STACK_GROWS_UPWARD  0
91         #define CPU_SP_ON_EMPTY_SLOT    0
92         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
93
94 #elif CPU_DSP56K
95
96         #define NOP                     asm(nop)
97         #define DISABLE_INTS            do { asm(bfset #0x0200,SR); asm(nop); } while (0)
98         #define ENABLE_INTS             do { asm(bfclr #0x0200,SR); asm(nop); } while (0)
99
100         #define DISABLE_IRQSAVE(x)  \
101                 do { asm(move SR,x); asm(bfset #0x0200,SR); } while (0)
102         #define ENABLE_IRQRESTORE(x)  \
103                 do { asm(move x,SR); } while (0)
104
105         typedef uint16_t cpuflags_t;
106         typedef unsigned int cpustack_t;
107
108         #define CPU_REGS_CNT            FIXME
109         #define CPU_SAVED_REGS_CNT      8
110         #define CPU_STACK_GROWS_UPWARD  1
111         #define CPU_SP_ON_EMPTY_SLOT    0
112         #define CPU_BYTE_ORDER          CPU_BIG_ENDIAN
113
114 #elif CPU_AVR
115
116         #define NOP                     asm volatile ("nop" ::)
117         #define DISABLE_INTS            asm volatile ("cli" ::)
118         #define ENABLE_INTS             asm volatile ("sei" ::)
119
120         #define DISABLE_IRQSAVE(x) \
121         do { \
122                 __asm__ __volatile__( \
123                         "in %0,__SREG__\n\t" \
124                         "cli" \
125                         : "=r" (x) : /* no inputs */ : "cc" \
126                 ); \
127         } while (0)
128
129         #define ENABLE_IRQRESTORE(x) \
130         do { \
131                 __asm__ __volatile__( \
132                         "out __SREG__,%0" : /* no outputs */ : "r" (x) : "cc" \
133                 ); \
134         } while (0)
135
136         typedef uint8_t cpuflags_t;
137         typedef uint8_t cpustack_t;
138
139         #define CPU_REGS_CNT            32
140         #define CPU_SAVED_REGS_CNT      18
141         #define CPU_STACK_GROWS_UPWARD  0
142         #define CPU_SP_ON_EMPTY_SLOT    1
143         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
144 #endif
145
146
147 #ifndef CPU_STACK_GROWS_UPWARD
148         #error CPU_STACK_GROWS_UPWARD should have been defined to either 0 or 1
149 #endif
150
151 #ifndef CPU_SP_ON_EMPTY_SLOT
152         #error CPU_SP_ON_EMPTY_SLOT should have been defined to either 0 or 1
153 #endif
154
155 /*
156  * Support stack handling peculiarities of a few CPUs.
157  *
158  * Most processors let their stack grow downward and
159  * keep SP pointing at the last pushed value.
160  */
161 #if !CPU_STACK_GROWS_UPWARD
162         #if !CPU_SP_ON_EMPTY_SLOT
163                 /* Most microprocessors (x86, m68k...) */
164                 #define CPU_PUSH_WORD(sp, data) \
165                         do { *--(sp) = (data); } while (0)
166                 #define CPU_POP_WORD(sp) \
167                         (*(sp)++)
168         #else
169                 /* AVR insanity */
170                 #define CPU_PUSH_WORD(sp, data) \
171                         do { *(sp)-- = (data); } while (0)
172                 #define CPU_POP_WORD(sp) \
173                         (*++(sp))
174         #endif
175
176 #else /* CPU_STACK_GROWS_UPWARD */
177
178         #if !CPU_SP_ON_EMPTY_SLOT
179                 /* DSP56K and other weirdos */
180                 #define CPU_PUSH_WORD(sp, data) \
181                         do { *++(sp) = (cpustack_t)(data); } while (0)
182                 #define CPU_POP_WORD(sp) \
183                         (*(sp)--)
184         #else
185                 #error I bet you cannot find a CPU like this
186         #endif
187 #endif
188
189
190 #if CPU_DSP56K
191         /* DSP56k pushes both PC and SR to the stack in the JSR instruction, but
192          * RTS discards SR while returning (it does not restore it). So we push
193          * 0 to fake the same context.
194          */
195         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
196                 do { \
197                         CPU_PUSH_WORD((sp), (func)); \
198                         CPU_PUSH_WORD((sp), 0x100); \
199                 } while (0);
200
201 #elif CPU_AVR
202         /* In AVR, the addresses are pushed into the stack as little-endian, while
203          * memory accesses are big-endian (actually, it's a 8-bit CPU, so there is
204          * no natural endianess).
205          */
206         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
207                 do { \
208                         uint16_t funcaddr = (uint16_t)(func); \
209                         CPU_PUSH_WORD((sp), funcaddr); \
210                         CPU_PUSH_WORD((sp), funcaddr>>8); \
211                 } while (0)
212
213 #else
214         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
215                 CPU_PUSH_WORD((sp), (func))
216 #endif
217
218
219 /*!
220  * \name SCHEDULER_IDLE
221  *
222  * \brief Invoked by the scheduler to stop the CPU when idle.
223  *
224  * This hook can be redefined to put the CPU in low-power mode, or to
225  * profile system load with an external strobe, or to save CPU cycles
226  * in hosted environments such as emulators.
227  */
228 #ifndef SCHEDULER_IDLE
229         #if defined(ARCH_EMUL) && (ARCH & ARCH_EMUL)
230                 /* This emulator hook should yeld the CPU to the host.  */
231                 EXTERN_C_BEGIN
232                 void SchedulerIdle(void);
233                 EXTERN_C_END
234         #else /* !ARCH_EMUL */
235                 #define SCHEDULER_IDLE /* nothing */
236         #endif /* !ARCH_EMUL */
237 #endif /* !SCHEDULER_IDLE */
238
239 #endif /* CPU_H */