xref: /openbmc/qemu/target/microblaze/cpu.h (revision 14a48c1d)
1 /*
2  *  MicroBlaze virtual CPU header
3  *
4  *  Copyright (c) 2009 Edgar E. Iglesias
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  * 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 
20 #ifndef MICROBLAZE_CPU_H
21 #define MICROBLAZE_CPU_H
22 
23 #include "qemu-common.h"
24 #include "cpu-qom.h"
25 #include "exec/cpu-defs.h"
26 #include "fpu/softfloat-types.h"
27 
28 typedef struct CPUMBState CPUMBState;
29 #if !defined(CONFIG_USER_ONLY)
30 #include "mmu.h"
31 #endif
32 
33 #define EXCP_MMU        1
34 #define EXCP_IRQ        2
35 #define EXCP_BREAK      3
36 #define EXCP_HW_BREAK   4
37 #define EXCP_HW_EXCP    5
38 
39 /* MicroBlaze-specific interrupt pending bits.  */
40 #define CPU_INTERRUPT_NMI       CPU_INTERRUPT_TGT_EXT_3
41 
42 /* Meanings of the MBCPU object's two inbound GPIO lines */
43 #define MB_CPU_IRQ 0
44 #define MB_CPU_FIR 1
45 
46 /* Register aliases. R0 - R15 */
47 #define R_SP     1
48 #define SR_PC    0
49 #define SR_MSR   1
50 #define SR_EAR   3
51 #define SR_ESR   5
52 #define SR_FSR   7
53 #define SR_BTR   0xb
54 #define SR_EDR   0xd
55 
56 /* MSR flags.  */
57 #define MSR_BE  (1<<0) /* 0x001 */
58 #define MSR_IE  (1<<1) /* 0x002 */
59 #define MSR_C   (1<<2) /* 0x004 */
60 #define MSR_BIP (1<<3) /* 0x008 */
61 #define MSR_FSL (1<<4) /* 0x010 */
62 #define MSR_ICE (1<<5) /* 0x020 */
63 #define MSR_DZ  (1<<6) /* 0x040 */
64 #define MSR_DCE (1<<7) /* 0x080 */
65 #define MSR_EE  (1<<8) /* 0x100 */
66 #define MSR_EIP (1<<9) /* 0x200 */
67 #define MSR_PVR (1<<10) /* 0x400 */
68 #define MSR_CC  (1<<31)
69 
70 /* Machine State Register (MSR) Fields */
71 #define MSR_UM (1<<11) /* User Mode */
72 #define MSR_UMS        (1<<12) /* User Mode Save */
73 #define MSR_VM (1<<13) /* Virtual Mode */
74 #define MSR_VMS        (1<<14) /* Virtual Mode Save */
75 
76 #define MSR_KERNEL      MSR_EE|MSR_VM
77 //#define MSR_USER     MSR_KERNEL|MSR_UM|MSR_IE
78 #define MSR_KERNEL_VMS  MSR_EE|MSR_VMS
79 //#define MSR_USER_VMS MSR_KERNEL_VMS|MSR_UMS|MSR_IE
80 
81 /* Exception State Register (ESR) Fields */
82 #define          ESR_DIZ       (1<<11) /* Zone Protection */
83 #define          ESR_S         (1<<10) /* Store instruction */
84 
85 #define          ESR_ESS_FSL_OFFSET     5
86 
87 #define          ESR_EC_FSL             0
88 #define          ESR_EC_UNALIGNED_DATA  1
89 #define          ESR_EC_ILLEGAL_OP      2
90 #define          ESR_EC_INSN_BUS        3
91 #define          ESR_EC_DATA_BUS        4
92 #define          ESR_EC_DIVZERO         5
93 #define          ESR_EC_FPU             6
94 #define          ESR_EC_PRIVINSN        7
95 #define          ESR_EC_STACKPROT       7  /* Same as PRIVINSN.  */
96 #define          ESR_EC_DATA_STORAGE    8
97 #define          ESR_EC_INSN_STORAGE    9
98 #define          ESR_EC_DATA_TLB        10
99 #define          ESR_EC_INSN_TLB        11
100 #define          ESR_EC_MASK            31
101 
102 /* Floating Point Status Register (FSR) Bits */
103 #define FSR_IO          (1<<4) /* Invalid operation */
104 #define FSR_DZ          (1<<3) /* Divide-by-zero */
105 #define FSR_OF          (1<<2) /* Overflow */
106 #define FSR_UF          (1<<1) /* Underflow */
107 #define FSR_DO          (1<<0) /* Denormalized operand error */
108 
109 /* Version reg.  */
110 /* Basic PVR mask */
111 #define PVR0_PVR_FULL_MASK              0x80000000
112 #define PVR0_USE_BARREL_MASK            0x40000000
113 #define PVR0_USE_DIV_MASK               0x20000000
114 #define PVR0_USE_HW_MUL_MASK            0x10000000
115 #define PVR0_USE_FPU_MASK               0x08000000
116 #define PVR0_USE_EXC_MASK               0x04000000
117 #define PVR0_USE_ICACHE_MASK            0x02000000
118 #define PVR0_USE_DCACHE_MASK            0x01000000
119 #define PVR0_USE_MMU_MASK               0x00800000
120 #define PVR0_USE_BTC			0x00400000
121 #define PVR0_ENDI_MASK                  0x00200000
122 #define PVR0_FAULT			0x00100000
123 #define PVR0_VERSION_MASK               0x0000FF00
124 #define PVR0_USER1_MASK                 0x000000FF
125 #define PVR0_SPROT_MASK                 0x00000001
126 
127 #define PVR0_VERSION_SHIFT              8
128 
129 /* User 2 PVR mask */
130 #define PVR1_USER2_MASK                 0xFFFFFFFF
131 
132 /* Configuration PVR masks */
133 #define PVR2_D_OPB_MASK                 0x80000000
134 #define PVR2_D_LMB_MASK                 0x40000000
135 #define PVR2_I_OPB_MASK                 0x20000000
136 #define PVR2_I_LMB_MASK                 0x10000000
137 #define PVR2_INTERRUPT_IS_EDGE_MASK     0x08000000
138 #define PVR2_EDGE_IS_POSITIVE_MASK      0x04000000
139 #define PVR2_D_PLB_MASK                 0x02000000      /* new */
140 #define PVR2_I_PLB_MASK                 0x01000000      /* new */
141 #define PVR2_INTERCONNECT               0x00800000      /* new */
142 #define PVR2_USE_EXTEND_FSL             0x00080000      /* new */
143 #define PVR2_USE_FSL_EXC                0x00040000      /* new */
144 #define PVR2_USE_MSR_INSTR              0x00020000
145 #define PVR2_USE_PCMP_INSTR             0x00010000
146 #define PVR2_AREA_OPTIMISED             0x00008000
147 #define PVR2_USE_BARREL_MASK            0x00004000
148 #define PVR2_USE_DIV_MASK               0x00002000
149 #define PVR2_USE_HW_MUL_MASK            0x00001000
150 #define PVR2_USE_FPU_MASK               0x00000800
151 #define PVR2_USE_MUL64_MASK             0x00000400
152 #define PVR2_USE_FPU2_MASK              0x00000200      /* new */
153 #define PVR2_USE_IPLBEXC                0x00000100
154 #define PVR2_USE_DPLBEXC                0x00000080
155 #define PVR2_OPCODE_0x0_ILL_MASK        0x00000040
156 #define PVR2_UNALIGNED_EXC_MASK         0x00000020
157 #define PVR2_ILL_OPCODE_EXC_MASK        0x00000010
158 #define PVR2_IOPB_BUS_EXC_MASK          0x00000008
159 #define PVR2_DOPB_BUS_EXC_MASK          0x00000004
160 #define PVR2_DIV_ZERO_EXC_MASK          0x00000002
161 #define PVR2_FPU_EXC_MASK               0x00000001
162 
163 /* Debug and exception PVR masks */
164 #define PVR3_DEBUG_ENABLED_MASK         0x80000000
165 #define PVR3_NUMBER_OF_PC_BRK_MASK      0x1E000000
166 #define PVR3_NUMBER_OF_RD_ADDR_BRK_MASK 0x00380000
167 #define PVR3_NUMBER_OF_WR_ADDR_BRK_MASK 0x0000E000
168 #define PVR3_FSL_LINKS_MASK             0x00000380
169 
170 /* ICache config PVR masks */
171 #define PVR4_USE_ICACHE_MASK            0x80000000
172 #define PVR4_ICACHE_ADDR_TAG_BITS_MASK  0x7C000000
173 #define PVR4_ICACHE_USE_FSL_MASK        0x02000000
174 #define PVR4_ICACHE_ALLOW_WR_MASK       0x01000000
175 #define PVR4_ICACHE_LINE_LEN_MASK       0x00E00000
176 #define PVR4_ICACHE_BYTE_SIZE_MASK      0x001F0000
177 
178 /* DCache config PVR masks */
179 #define PVR5_USE_DCACHE_MASK            0x80000000
180 #define PVR5_DCACHE_ADDR_TAG_BITS_MASK  0x7C000000
181 #define PVR5_DCACHE_USE_FSL_MASK        0x02000000
182 #define PVR5_DCACHE_ALLOW_WR_MASK       0x01000000
183 #define PVR5_DCACHE_LINE_LEN_MASK       0x00E00000
184 #define PVR5_DCACHE_BYTE_SIZE_MASK      0x001F0000
185 #define PVR5_DCACHE_WRITEBACK_MASK      0x00004000
186 
187 /* ICache base address PVR mask */
188 #define PVR6_ICACHE_BASEADDR_MASK       0xFFFFFFFF
189 
190 /* ICache high address PVR mask */
191 #define PVR7_ICACHE_HIGHADDR_MASK       0xFFFFFFFF
192 
193 /* DCache base address PVR mask */
194 #define PVR8_DCACHE_BASEADDR_MASK       0xFFFFFFFF
195 
196 /* DCache high address PVR mask */
197 #define PVR9_DCACHE_HIGHADDR_MASK       0xFFFFFFFF
198 
199 /* Target family PVR mask */
200 #define PVR10_TARGET_FAMILY_MASK        0xFF000000
201 #define PVR10_ASIZE_SHIFT               18
202 
203 /* MMU descrtiption */
204 #define PVR11_USE_MMU                   0xC0000000
205 #define PVR11_MMU_ITLB_SIZE             0x38000000
206 #define PVR11_MMU_DTLB_SIZE             0x07000000
207 #define PVR11_MMU_TLB_ACCESS            0x00C00000
208 #define PVR11_MMU_ZONES                 0x003E0000
209 /* MSR Reset value PVR mask */
210 #define PVR11_MSR_RESET_VALUE_MASK      0x000007FF
211 
212 #define C_PVR_NONE                      0
213 #define C_PVR_BASIC                     1
214 #define C_PVR_FULL                      2
215 
216 /* CPU flags.  */
217 
218 /* Condition codes.  */
219 #define CC_GE  5
220 #define CC_GT  4
221 #define CC_LE  3
222 #define CC_LT  2
223 #define CC_NE  1
224 #define CC_EQ  0
225 
226 #define STREAM_EXCEPTION (1 << 0)
227 #define STREAM_ATOMIC    (1 << 1)
228 #define STREAM_TEST      (1 << 2)
229 #define STREAM_CONTROL   (1 << 3)
230 #define STREAM_NONBLOCK  (1 << 4)
231 
232 struct CPUMBState {
233     uint32_t debug;
234     uint32_t btaken;
235     uint64_t btarget;
236     uint32_t bimm;
237 
238     uint32_t imm;
239     uint32_t regs[32];
240     uint64_t sregs[14];
241     float_status fp_status;
242     /* Stack protectors. Yes, it's a hw feature.  */
243     uint32_t slr, shr;
244 
245     /* lwx/swx reserved address */
246 #define RES_ADDR_NONE 0xffffffff /* Use 0xffffffff to indicate no reservation */
247     target_ulong res_addr;
248     uint32_t res_val;
249 
250     /* Internal flags.  */
251 #define IMM_FLAG	4
252 #define MSR_EE_FLAG     (1 << 8)
253 #define DRTI_FLAG	(1 << 16)
254 #define DRTE_FLAG	(1 << 17)
255 #define DRTB_FLAG	(1 << 18)
256 #define D_FLAG		(1 << 19)  /* Bit in ESR.  */
257 /* TB dependent CPUMBState.  */
258 #define IFLAGS_TB_MASK  (D_FLAG | IMM_FLAG | DRTI_FLAG | DRTE_FLAG | DRTB_FLAG)
259     uint32_t iflags;
260 
261 #if !defined(CONFIG_USER_ONLY)
262     /* Unified MMU.  */
263     struct microblaze_mmu mmu;
264 #endif
265 
266     /* Fields up to this point are cleared by a CPU reset */
267     struct {} end_reset_fields;
268 
269     /* These fields are preserved on reset.  */
270 
271     struct {
272         uint32_t regs[13];
273     } pvr;
274 };
275 
276 /**
277  * MicroBlazeCPU:
278  * @env: #CPUMBState
279  *
280  * A MicroBlaze CPU.
281  */
282 struct MicroBlazeCPU {
283     /*< private >*/
284     CPUState parent_obj;
285 
286     /*< public >*/
287 
288     CPUNegativeOffsetState neg;
289     CPUMBState env;
290 
291     /* Microblaze Configuration Settings */
292     struct {
293         bool stackprot;
294         uint32_t base_vectors;
295         uint8_t addr_size;
296         uint8_t use_fpu;
297         uint8_t use_hw_mul;
298         bool use_barrel;
299         bool use_div;
300         bool use_msr_instr;
301         bool use_pcmp_instr;
302         bool use_mmu;
303         bool dcache_writeback;
304         bool endi;
305         bool dopb_bus_exception;
306         bool iopb_bus_exception;
307         char *version;
308         uint8_t pvr;
309     } cfg;
310 };
311 
312 
313 void mb_cpu_do_interrupt(CPUState *cs);
314 bool mb_cpu_exec_interrupt(CPUState *cs, int int_req);
315 void mb_cpu_dump_state(CPUState *cpu, FILE *f, int flags);
316 hwaddr mb_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
317 int mb_cpu_gdb_read_register(CPUState *cpu, uint8_t *buf, int reg);
318 int mb_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
319 
320 void mb_tcg_init(void);
321 /* you can call this signal handler from your SIGBUS and SIGSEGV
322    signal handlers to inform the virtual CPU of exceptions. non zero
323    is returned if the signal was handled by the virtual CPU.  */
324 int cpu_mb_signal_handler(int host_signum, void *pinfo,
325                           void *puc);
326 
327 #define CPU_RESOLVING_TYPE TYPE_MICROBLAZE_CPU
328 
329 #define cpu_signal_handler cpu_mb_signal_handler
330 
331 /* MMU modes definitions */
332 #define MMU_MODE0_SUFFIX _nommu
333 #define MMU_MODE1_SUFFIX _kernel
334 #define MMU_MODE2_SUFFIX _user
335 #define MMU_NOMMU_IDX   0
336 #define MMU_KERNEL_IDX  1
337 #define MMU_USER_IDX    2
338 /* See NB_MMU_MODES further up the file.  */
339 
340 bool mb_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
341                      MMUAccessType access_type, int mmu_idx,
342                      bool probe, uintptr_t retaddr);
343 
344 typedef CPUMBState CPUArchState;
345 typedef MicroBlazeCPU ArchCPU;
346 
347 #include "exec/cpu-all.h"
348 
349 static inline void cpu_get_tb_cpu_state(CPUMBState *env, target_ulong *pc,
350                                         target_ulong *cs_base, uint32_t *flags)
351 {
352     *pc = env->sregs[SR_PC];
353     *cs_base = 0;
354     *flags = (env->iflags & IFLAGS_TB_MASK) |
355                  (env->sregs[SR_MSR] & (MSR_UM | MSR_VM | MSR_EE));
356 }
357 
358 #if !defined(CONFIG_USER_ONLY)
359 void mb_cpu_transaction_failed(CPUState *cs, hwaddr physaddr, vaddr addr,
360                                unsigned size, MMUAccessType access_type,
361                                int mmu_idx, MemTxAttrs attrs,
362                                MemTxResult response, uintptr_t retaddr);
363 #endif
364 
365 static inline int cpu_mmu_index(CPUMBState *env, bool ifetch)
366 {
367     MicroBlazeCPU *cpu = env_archcpu(env);
368 
369     /* Are we in nommu mode?.  */
370     if (!(env->sregs[SR_MSR] & MSR_VM) || !cpu->cfg.use_mmu) {
371         return MMU_NOMMU_IDX;
372     }
373 
374     if (env->sregs[SR_MSR] & MSR_UM) {
375         return MMU_USER_IDX;
376     }
377     return MMU_KERNEL_IDX;
378 }
379 
380 #endif
381