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