Update to a hopefully more future proof FSF address
[sdk/emulator/qemu.git] / target-sh4 / cpu.h
1 /*
2  *  SH4 emulation
3  *
4  *  Copyright (c) 2005 Samuel Tardieu
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18  */
19 #ifndef _CPU_SH4_H
20 #define _CPU_SH4_H
21
22 #include "config.h"
23
24 #define TARGET_LONG_BITS 32
25 #define TARGET_HAS_ICE 1
26
27 #define ELF_MACHINE     EM_SH
28
29 /* CPU Subtypes */
30 #define SH_CPU_SH7750  (1 << 0)
31 #define SH_CPU_SH7750S (1 << 1)
32 #define SH_CPU_SH7750R (1 << 2)
33 #define SH_CPU_SH7751  (1 << 3)
34 #define SH_CPU_SH7751R (1 << 4)
35 #define SH_CPU_SH7785  (1 << 5)
36 #define SH_CPU_SH7750_ALL (SH_CPU_SH7750 | SH_CPU_SH7750S | SH_CPU_SH7750R)
37 #define SH_CPU_SH7751_ALL (SH_CPU_SH7751 | SH_CPU_SH7751R)
38
39 #define CPUState struct CPUSH4State
40
41 #include "cpu-defs.h"
42
43 #include "softfloat.h"
44
45 #define TARGET_PAGE_BITS 12     /* 4k XXXXX */
46
47 #define SR_MD (1 << 30)
48 #define SR_RB (1 << 29)
49 #define SR_BL (1 << 28)
50 #define SR_FD (1 << 15)
51 #define SR_M  (1 << 9)
52 #define SR_Q  (1 << 8)
53 #define SR_I3 (1 << 7)
54 #define SR_I2 (1 << 6)
55 #define SR_I1 (1 << 5)
56 #define SR_I0 (1 << 4)
57 #define SR_S  (1 << 1)
58 #define SR_T  (1 << 0)
59
60 #define FPSCR_FR (1 << 21)
61 #define FPSCR_SZ (1 << 20)
62 #define FPSCR_PR (1 << 19)
63 #define FPSCR_DN (1 << 18)
64 #define DELAY_SLOT             (1 << 0)
65 #define DELAY_SLOT_CONDITIONAL (1 << 1)
66 #define DELAY_SLOT_TRUE        (1 << 2)
67 #define DELAY_SLOT_CLEARME     (1 << 3)
68 /* The dynamic value of the DELAY_SLOT_TRUE flag determines whether the jump
69  * after the delay slot should be taken or not. It is calculated from SR_T.
70  *
71  * It is unclear if it is permitted to modify the SR_T flag in a delay slot.
72  * The use of DELAY_SLOT_TRUE flag makes us accept such SR_T modification.
73  */
74
75 /* XXXXX The structure could be made more compact */
76 typedef struct tlb_t {
77     uint8_t asid;               /* address space identifier */
78     uint32_t vpn;               /* virtual page number */
79     uint8_t v;                  /* validity */
80     uint32_t ppn;               /* physical page number */
81     uint8_t sz;                 /* page size */
82     uint32_t size;              /* cached page size in bytes */
83     uint8_t sh;                 /* share status */
84     uint8_t c;                  /* cacheability */
85     uint8_t pr;                 /* protection key */
86     uint8_t d;                  /* dirty */
87     uint8_t wt;                 /* write through */
88     uint8_t sa;                 /* space attribute (PCMCIA) */
89     uint8_t tc;                 /* timing control */
90 } tlb_t;
91
92 #define UTLB_SIZE 64
93 #define ITLB_SIZE 4
94
95 #define NB_MMU_MODES 2
96
97 enum sh_features {
98     SH_FEATURE_SH4A = 1,
99     SH_FEATURE_BCR3_AND_BCR4 = 2,
100 };
101
102 typedef struct memory_content {
103     uint32_t address;
104     uint32_t value;
105     struct memory_content *next;
106 } memory_content;
107
108 typedef struct CPUSH4State {
109     int id;                     /* CPU model */
110
111     uint32_t flags;             /* general execution flags */
112     uint32_t gregs[24];         /* general registers */
113     float32 fregs[32];          /* floating point registers */
114     uint32_t sr;                /* status register */
115     uint32_t ssr;               /* saved status register */
116     uint32_t spc;               /* saved program counter */
117     uint32_t gbr;               /* global base register */
118     uint32_t vbr;               /* vector base register */
119     uint32_t sgr;               /* saved global register 15 */
120     uint32_t dbr;               /* debug base register */
121     uint32_t pc;                /* program counter */
122     uint32_t delayed_pc;        /* target of delayed jump */
123     uint32_t mach;              /* multiply and accumulate high */
124     uint32_t macl;              /* multiply and accumulate low */
125     uint32_t pr;                /* procedure register */
126     uint32_t fpscr;             /* floating point status/control register */
127     uint32_t fpul;              /* floating point communication register */
128
129     /* float point status register */
130     float_status fp_status;
131
132     /* The features that we should emulate. See sh_features above.  */
133     uint32_t features;
134
135     /* Those belong to the specific unit (SH7750) but are handled here */
136     uint32_t mmucr;             /* MMU control register */
137     uint32_t pteh;              /* page table entry high register */
138     uint32_t ptel;              /* page table entry low register */
139     uint32_t ptea;              /* page table entry assistance register */
140     uint32_t ttb;               /* tranlation table base register */
141     uint32_t tea;               /* TLB exception address register */
142     uint32_t tra;               /* TRAPA exception register */
143     uint32_t expevt;            /* exception event register */
144     uint32_t intevt;            /* interrupt event register */
145
146     uint32_t pvr;               /* Processor Version Register */
147     uint32_t prr;               /* Processor Revision Register */
148     uint32_t cvr;               /* Cache Version Register */
149
150     uint32_t ldst;
151
152      CPU_COMMON tlb_t utlb[UTLB_SIZE];  /* unified translation table */
153     tlb_t itlb[ITLB_SIZE];      /* instruction translation table */
154     void *intc_handle;
155     int intr_at_halt;           /* SR_BL ignored during sleep */
156     memory_content *movcal_backup;
157     memory_content **movcal_backup_tail;
158 } CPUSH4State;
159
160 CPUSH4State *cpu_sh4_init(const char *cpu_model);
161 int cpu_sh4_exec(CPUSH4State * s);
162 int cpu_sh4_signal_handler(int host_signum, void *pinfo,
163                            void *puc);
164 int cpu_sh4_handle_mmu_fault(CPUSH4State * env, target_ulong address, int rw,
165                              int mmu_idx, int is_softmmu);
166 void do_interrupt(CPUSH4State * env);
167
168 void sh4_cpu_list(FILE *f, int (*cpu_fprintf)(FILE *f, const char *fmt, ...));
169 void cpu_sh4_write_mmaped_utlb_addr(CPUSH4State *s, target_phys_addr_t addr,
170                                     uint32_t mem_value);
171
172 int cpu_sh4_is_cached(CPUSH4State * env, target_ulong addr);
173
174 static inline void cpu_set_tls(CPUSH4State *env, target_ulong newtls)
175 {
176   env->gbr = newtls;
177 }
178
179 void cpu_load_tlb(CPUSH4State * env);
180
181 #include "softfloat.h"
182
183 #define cpu_init cpu_sh4_init
184 #define cpu_exec cpu_sh4_exec
185 #define cpu_gen_code cpu_sh4_gen_code
186 #define cpu_signal_handler cpu_sh4_signal_handler
187 #define cpu_list sh4_cpu_list
188
189 /* MMU modes definitions */
190 #define MMU_MODE0_SUFFIX _kernel
191 #define MMU_MODE1_SUFFIX _user
192 #define MMU_USER_IDX 1
193 static inline int cpu_mmu_index (CPUState *env)
194 {
195     return (env->sr & SR_MD) == 0 ? 1 : 0;
196 }
197
198 #if defined(CONFIG_USER_ONLY)
199 static inline void cpu_clone_regs(CPUState *env, target_ulong newsp)
200 {
201     if (newsp)
202         env->gregs[15] = newsp;
203     env->gregs[0] = 0;
204 }
205 #endif
206
207 #include "cpu-all.h"
208 #include "exec-all.h"
209
210 /* Memory access type */
211 enum {
212     /* Privilege */
213     ACCESS_PRIV = 0x01,
214     /* Direction */
215     ACCESS_WRITE = 0x02,
216     /* Type of instruction */
217     ACCESS_CODE = 0x10,
218     ACCESS_INT = 0x20
219 };
220
221 /* MMU control register */
222 #define MMUCR    0x1F000010
223 #define MMUCR_AT (1<<0)
224 #define MMUCR_SV (1<<8)
225 #define MMUCR_URC_BITS (6)
226 #define MMUCR_URC_OFFSET (10)
227 #define MMUCR_URC_SIZE (1 << MMUCR_URC_BITS)
228 #define MMUCR_URC_MASK (((MMUCR_URC_SIZE) - 1) << MMUCR_URC_OFFSET)
229 static inline int cpu_mmucr_urc (uint32_t mmucr)
230 {
231     return ((mmucr & MMUCR_URC_MASK) >> MMUCR_URC_OFFSET);
232 }
233
234 /* PTEH : Page Translation Entry High register */
235 #define PTEH_ASID_BITS (8)
236 #define PTEH_ASID_SIZE (1 << PTEH_ASID_BITS)
237 #define PTEH_ASID_MASK (PTEH_ASID_SIZE - 1)
238 #define cpu_pteh_asid(pteh) ((pteh) & PTEH_ASID_MASK)
239 #define PTEH_VPN_BITS (22)
240 #define PTEH_VPN_OFFSET (10)
241 #define PTEH_VPN_SIZE (1 << PTEH_VPN_BITS)
242 #define PTEH_VPN_MASK (((PTEH_VPN_SIZE) - 1) << PTEH_VPN_OFFSET)
243 static inline int cpu_pteh_vpn (uint32_t pteh)
244 {
245     return ((pteh & PTEH_VPN_MASK) >> PTEH_VPN_OFFSET);
246 }
247
248 /* PTEL : Page Translation Entry Low register */
249 #define PTEL_V        (1 << 8)
250 #define cpu_ptel_v(ptel) (((ptel) & PTEL_V) >> 8)
251 #define PTEL_C        (1 << 3)
252 #define cpu_ptel_c(ptel) (((ptel) & PTEL_C) >> 3)
253 #define PTEL_D        (1 << 2)
254 #define cpu_ptel_d(ptel) (((ptel) & PTEL_D) >> 2)
255 #define PTEL_SH       (1 << 1)
256 #define cpu_ptel_sh(ptel)(((ptel) & PTEL_SH) >> 1)
257 #define PTEL_WT       (1 << 0)
258 #define cpu_ptel_wt(ptel) ((ptel) & PTEL_WT)
259
260 #define PTEL_SZ_HIGH_OFFSET  (7)
261 #define PTEL_SZ_HIGH  (1 << PTEL_SZ_HIGH_OFFSET)
262 #define PTEL_SZ_LOW_OFFSET   (4)
263 #define PTEL_SZ_LOW   (1 << PTEL_SZ_LOW_OFFSET)
264 static inline int cpu_ptel_sz (uint32_t ptel)
265 {
266     int sz;
267     sz = (ptel & PTEL_SZ_HIGH) >> PTEL_SZ_HIGH_OFFSET;
268     sz <<= 1;
269     sz |= (ptel & PTEL_SZ_LOW) >> PTEL_SZ_LOW_OFFSET;
270     return sz;
271 }
272
273 #define PTEL_PPN_BITS (19)
274 #define PTEL_PPN_OFFSET (10)
275 #define PTEL_PPN_SIZE (1 << PTEL_PPN_BITS)
276 #define PTEL_PPN_MASK (((PTEL_PPN_SIZE) - 1) << PTEL_PPN_OFFSET)
277 static inline int cpu_ptel_ppn (uint32_t ptel)
278 {
279     return ((ptel & PTEL_PPN_MASK) >> PTEL_PPN_OFFSET);
280 }
281
282 #define PTEL_PR_BITS   (2)
283 #define PTEL_PR_OFFSET (5)
284 #define PTEL_PR_SIZE (1 << PTEL_PR_BITS)
285 #define PTEL_PR_MASK (((PTEL_PR_SIZE) - 1) << PTEL_PR_OFFSET)
286 static inline int cpu_ptel_pr (uint32_t ptel)
287 {
288     return ((ptel & PTEL_PR_MASK) >> PTEL_PR_OFFSET);
289 }
290
291 /* PTEA : Page Translation Entry Assistance register */
292 #define PTEA_SA_BITS (3)
293 #define PTEA_SA_SIZE (1 << PTEA_SA_BITS)
294 #define PTEA_SA_MASK (PTEA_SA_SIZE - 1)
295 #define cpu_ptea_sa(ptea) ((ptea) & PTEA_SA_MASK)
296 #define PTEA_TC        (1 << 3)
297 #define cpu_ptea_tc(ptea) (((ptea) & PTEA_TC) >> 3)
298
299 static inline void cpu_pc_from_tb(CPUState *env, TranslationBlock *tb)
300 {
301     env->pc = tb->pc;
302     env->flags = tb->flags;
303 }
304
305 #define TB_FLAG_PENDING_MOVCA  (1 << 4)
306
307 static inline void cpu_get_tb_cpu_state(CPUState *env, target_ulong *pc,
308                                         target_ulong *cs_base, int *flags)
309 {
310     *pc = env->pc;
311     *cs_base = 0;
312     *flags = (env->flags & (DELAY_SLOT | DELAY_SLOT_CONDITIONAL
313                     | DELAY_SLOT_TRUE | DELAY_SLOT_CLEARME))   /* Bits  0- 3 */
314             | (env->fpscr & (FPSCR_FR | FPSCR_SZ | FPSCR_PR))  /* Bits 19-21 */
315             | (env->sr & (SR_MD | SR_RB))                      /* Bits 29-30 */
316             | (env->sr & SR_FD)                                /* Bit 15 */
317             | (env->movcal_backup ? TB_FLAG_PENDING_MOVCA : 0); /* Bit 4 */
318 }
319
320 #endif                          /* _CPU_SH4_H */