qemu-tech: document lazy condition code evaluation in cpu.h
[sdk/emulator/qemu.git] / target-m68k / cpu.h
1 /*
2  * m68k virtual CPU header
3  *
4  *  Copyright (c) 2005-2007 CodeSourcery
5  *  Written by Paul Brook
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef M68K_CPU_H
22 #define M68K_CPU_H
23
24 #define TARGET_LONG_BITS 32
25
26 #define CPUArchState struct CPUM68KState
27
28 #include "qemu-common.h"
29 #include "exec/cpu-defs.h"
30 #include "cpu-qom.h"
31 #include "fpu/softfloat.h"
32
33 #define MAX_QREGS 32
34
35 #define EXCP_ACCESS         2   /* Access (MMU) error.  */
36 #define EXCP_ADDRESS        3   /* Address error.  */
37 #define EXCP_ILLEGAL        4   /* Illegal instruction.  */
38 #define EXCP_DIV0           5   /* Divide by zero */
39 #define EXCP_PRIVILEGE      8   /* Privilege violation.  */
40 #define EXCP_TRACE          9
41 #define EXCP_LINEA          10  /* Unimplemented line-A (MAC) opcode.  */
42 #define EXCP_LINEF          11  /* Unimplemented line-F (FPU) opcode.  */
43 #define EXCP_DEBUGNBP       12  /* Non-breakpoint debug interrupt.  */
44 #define EXCP_DEBEGBP        13  /* Breakpoint debug interrupt.  */
45 #define EXCP_FORMAT         14  /* RTE format error.  */
46 #define EXCP_UNINITIALIZED  15
47 #define EXCP_TRAP0          32   /* User trap #0.  */
48 #define EXCP_TRAP15         47   /* User trap #15.  */
49 #define EXCP_UNSUPPORTED    61
50 #define EXCP_ICE            13
51
52 #define EXCP_RTE            0x100
53 #define EXCP_HALT_INSN      0x101
54
55 #define NB_MMU_MODES 2
56
57 typedef struct CPUM68KState {
58     uint32_t dregs[8];
59     uint32_t aregs[8];
60     uint32_t pc;
61     uint32_t sr;
62
63     /* SSP and USP.  The current_sp is stored in aregs[7], the other here.  */
64     int current_sp;
65     uint32_t sp[2];
66
67     /* Condition flags.  */
68     uint32_t cc_op;
69     uint32_t cc_dest;
70     uint32_t cc_src;
71     uint32_t cc_x;
72
73     float64 fregs[8];
74     float64 fp_result;
75     uint32_t fpcr;
76     uint32_t fpsr;
77     float_status fp_status;
78
79     uint64_t mactmp;
80     /* EMAC Hardware deals with 48-bit values composed of one 32-bit and
81        two 8-bit parts.  We store a single 64-bit value and
82        rearrange/extend this when changing modes.  */
83     uint64_t macc[4];
84     uint32_t macsr;
85     uint32_t mac_mask;
86
87     /* Temporary storage for DIV helpers.  */
88     uint32_t div1;
89     uint32_t div2;
90
91     /* MMU status.  */
92     struct {
93         uint32_t ar;
94     } mmu;
95
96     /* Control registers.  */
97     uint32_t vbr;
98     uint32_t mbar;
99     uint32_t rambar0;
100     uint32_t cacr;
101
102     int pending_vector;
103     int pending_level;
104
105     uint32_t qregs[MAX_QREGS];
106
107     CPU_COMMON
108
109     /* Fields from here on are preserved across CPU reset. */
110     uint32_t features;
111 } CPUM68KState;
112
113 /**
114  * M68kCPU:
115  * @env: #CPUM68KState
116  *
117  * A Motorola 68k CPU.
118  */
119 struct M68kCPU {
120     /*< private >*/
121     CPUState parent_obj;
122     /*< public >*/
123
124     CPUM68KState env;
125 };
126
127 static inline M68kCPU *m68k_env_get_cpu(CPUM68KState *env)
128 {
129     return container_of(env, M68kCPU, env);
130 }
131
132 #define ENV_GET_CPU(e) CPU(m68k_env_get_cpu(e))
133
134 #define ENV_OFFSET offsetof(M68kCPU, env)
135
136 void m68k_cpu_do_interrupt(CPUState *cpu);
137 bool m68k_cpu_exec_interrupt(CPUState *cpu, int int_req);
138 void m68k_cpu_dump_state(CPUState *cpu, FILE *f, fprintf_function cpu_fprintf,
139                          int flags);
140 hwaddr m68k_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
141 int m68k_cpu_gdb_read_register(CPUState *cpu, uint8_t *buf, int reg);
142 int m68k_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
143
144 void m68k_cpu_exec_enter(CPUState *cs);
145 void m68k_cpu_exec_exit(CPUState *cs);
146
147 void m68k_tcg_init(void);
148 void m68k_cpu_init_gdb(M68kCPU *cpu);
149 M68kCPU *cpu_m68k_init(const char *cpu_model);
150 /* you can call this signal handler from your SIGBUS and SIGSEGV
151    signal handlers to inform the virtual CPU of exceptions. non zero
152    is returned if the signal was handled by the virtual CPU.  */
153 int cpu_m68k_signal_handler(int host_signum, void *pinfo,
154                            void *puc);
155 void cpu_m68k_flush_flags(CPUM68KState *, int);
156
157
158 /* Instead of computing the condition codes after each m68k instruction,
159  * QEMU just stores one operand (called CC_SRC), the result
160  * (called CC_DEST) and the type of operation (called CC_OP). When the
161  * condition codes are needed, the condition codes can be calculated
162  * using this information. Condition codes are not generated if they
163  * are only needed for conditional branches.
164  */
165 enum {
166     CC_OP_DYNAMIC, /* Use env->cc_op  */
167     CC_OP_FLAGS, /* CC_DEST = CVZN, CC_SRC = unused */
168     CC_OP_LOGIC, /* CC_DEST = result, CC_SRC = unused */
169     CC_OP_ADD,   /* CC_DEST = result, CC_SRC = source */
170     CC_OP_SUB,   /* CC_DEST = result, CC_SRC = source */
171     CC_OP_CMPB,  /* CC_DEST = result, CC_SRC = source */
172     CC_OP_CMPW,  /* CC_DEST = result, CC_SRC = source */
173     CC_OP_ADDX,  /* CC_DEST = result, CC_SRC = source */
174     CC_OP_SUBX,  /* CC_DEST = result, CC_SRC = source */
175     CC_OP_SHIFT, /* CC_DEST = result, CC_SRC = carry */
176 };
177
178 #define CCF_C 0x01
179 #define CCF_V 0x02
180 #define CCF_Z 0x04
181 #define CCF_N 0x08
182 #define CCF_X 0x10
183
184 #define SR_I_SHIFT 8
185 #define SR_I  0x0700
186 #define SR_M  0x1000
187 #define SR_S  0x2000
188 #define SR_T  0x8000
189
190 #define M68K_SSP    0
191 #define M68K_USP    1
192
193 /* CACR fields are implementation defined, but some bits are common.  */
194 #define M68K_CACR_EUSP  0x10
195
196 #define MACSR_PAV0  0x100
197 #define MACSR_OMC   0x080
198 #define MACSR_SU    0x040
199 #define MACSR_FI    0x020
200 #define MACSR_RT    0x010
201 #define MACSR_N     0x008
202 #define MACSR_Z     0x004
203 #define MACSR_V     0x002
204 #define MACSR_EV    0x001
205
206 void m68k_set_irq_level(M68kCPU *cpu, int level, uint8_t vector);
207 void m68k_switch_sp(CPUM68KState *env);
208
209 #define M68K_FPCR_PREC (1 << 6)
210
211 void do_m68k_semihosting(CPUM68KState *env, int nr);
212
213 /* There are 4 ColdFire core ISA revisions: A, A+, B and C.
214    Each feature covers the subset of instructions common to the
215    ISA revisions mentioned.  */
216
217 enum m68k_features {
218     M68K_FEATURE_CF_ISA_A,
219     M68K_FEATURE_CF_ISA_B, /* (ISA B or C).  */
220     M68K_FEATURE_CF_ISA_APLUSC, /* BIT/BITREV, FF1, STRLDSR (ISA A+ or C).  */
221     M68K_FEATURE_BRAL, /* Long unconditional branch.  (ISA A+ or B).  */
222     M68K_FEATURE_CF_FPU,
223     M68K_FEATURE_CF_MAC,
224     M68K_FEATURE_CF_EMAC,
225     M68K_FEATURE_CF_EMAC_B, /* Revision B EMAC (dual accumulate).  */
226     M68K_FEATURE_USP, /* User Stack Pointer.  (ISA A+, B or C).  */
227     M68K_FEATURE_EXT_FULL, /* 68020+ full extension word.  */
228     M68K_FEATURE_WORD_INDEX /* word sized address index registers.  */
229 };
230
231 static inline int m68k_feature(CPUM68KState *env, int feature)
232 {
233     return (env->features & (1u << feature)) != 0;
234 }
235
236 void m68k_cpu_list(FILE *f, fprintf_function cpu_fprintf);
237
238 void register_m68k_insns (CPUM68KState *env);
239
240 #ifdef CONFIG_USER_ONLY
241 /* Linux uses 8k pages.  */
242 #define TARGET_PAGE_BITS 13
243 #else
244 /* Smallest TLB entry size is 1k.  */
245 #define TARGET_PAGE_BITS 10
246 #endif
247
248 #define TARGET_PHYS_ADDR_SPACE_BITS 32
249 #define TARGET_VIRT_ADDR_SPACE_BITS 32
250
251 #define cpu_init(cpu_model) CPU(cpu_m68k_init(cpu_model))
252
253 #define cpu_signal_handler cpu_m68k_signal_handler
254 #define cpu_list m68k_cpu_list
255
256 /* MMU modes definitions */
257 #define MMU_MODE0_SUFFIX _kernel
258 #define MMU_MODE1_SUFFIX _user
259 #define MMU_USER_IDX 1
260 static inline int cpu_mmu_index (CPUM68KState *env, bool ifetch)
261 {
262     return (env->sr & SR_S) == 0 ? 1 : 0;
263 }
264
265 int m68k_cpu_handle_mmu_fault(CPUState *cpu, vaddr address, int rw,
266                               int mmu_idx);
267
268 #include "exec/cpu-all.h"
269
270 static inline void cpu_get_tb_cpu_state(CPUM68KState *env, target_ulong *pc,
271                                         target_ulong *cs_base, uint32_t *flags)
272 {
273     *pc = env->pc;
274     *cs_base = 0;
275     *flags = (env->fpcr & M68K_FPCR_PREC)       /* Bit  6 */
276             | (env->sr & SR_S)                  /* Bit  13 */
277             | ((env->macsr >> 4) & 0xf);        /* Bits 0-3 */
278 }
279
280 #endif