xref: /qemu/target/microblaze/cpu.h (revision 22a7c2f239229b2ee9fcbac03cb598d9aebb9196)
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.1 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 "cpu-qom.h"
24 #include "exec/cpu-defs.h"
25 #include "qemu/cpu-float.h"
26 #include "exec/cpu-interrupt.h"
27 
28 typedef struct CPUArchState 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_SYSCALL    3  /* user-only */
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_W         (1<<11) /* Unaligned word access */
84 #define          ESR_S         (1<<10) /* Store instruction */
85 
86 #define          ESR_ESS_FSL_OFFSET     5
87 
88 #define          ESR_ESS_MASK  (0x7f << 5)
89 
90 #define          ESR_EC_FSL             0
91 #define          ESR_EC_UNALIGNED_DATA  1
92 #define          ESR_EC_ILLEGAL_OP      2
93 #define          ESR_EC_INSN_BUS        3
94 #define          ESR_EC_DATA_BUS        4
95 #define          ESR_EC_DIVZERO         5
96 #define          ESR_EC_FPU             6
97 #define          ESR_EC_PRIVINSN        7
98 #define          ESR_EC_STACKPROT       7  /* Same as PRIVINSN.  */
99 #define          ESR_EC_DATA_STORAGE    8
100 #define          ESR_EC_INSN_STORAGE    9
101 #define          ESR_EC_DATA_TLB        10
102 #define          ESR_EC_INSN_TLB        11
103 #define          ESR_EC_MASK            31
104 
105 /* Floating Point Status Register (FSR) Bits */
106 #define FSR_IO          (1<<4) /* Invalid operation */
107 #define FSR_DZ          (1<<3) /* Divide-by-zero */
108 #define FSR_OF          (1<<2) /* Overflow */
109 #define FSR_UF          (1<<1) /* Underflow */
110 #define FSR_DO          (1<<0) /* Denormalized operand error */
111 
112 /* Version reg.  */
113 /* Basic PVR mask */
114 #define PVR0_PVR_FULL_MASK              0x80000000
115 #define PVR0_USE_BARREL_MASK            0x40000000
116 #define PVR0_USE_DIV_MASK               0x20000000
117 #define PVR0_USE_HW_MUL_MASK            0x10000000
118 #define PVR0_USE_FPU_MASK               0x08000000
119 #define PVR0_USE_EXC_MASK               0x04000000
120 #define PVR0_USE_ICACHE_MASK            0x02000000
121 #define PVR0_USE_DCACHE_MASK            0x01000000
122 #define PVR0_USE_MMU_MASK               0x00800000
123 #define PVR0_USE_BTC			0x00400000
124 #define PVR0_ENDI_MASK                  0x00200000
125 #define PVR0_FAULT			0x00100000
126 #define PVR0_VERSION_MASK               0x0000FF00
127 #define PVR0_USER1_MASK                 0x000000FF
128 #define PVR0_SPROT_MASK                 0x00000001
129 
130 #define PVR0_VERSION_SHIFT              8
131 
132 /* User 2 PVR mask */
133 #define PVR1_USER2_MASK                 0xFFFFFFFF
134 
135 /* Configuration PVR masks */
136 #define PVR2_D_OPB_MASK                 0x80000000
137 #define PVR2_D_LMB_MASK                 0x40000000
138 #define PVR2_I_OPB_MASK                 0x20000000
139 #define PVR2_I_LMB_MASK                 0x10000000
140 #define PVR2_INTERRUPT_IS_EDGE_MASK     0x08000000
141 #define PVR2_EDGE_IS_POSITIVE_MASK      0x04000000
142 #define PVR2_D_PLB_MASK                 0x02000000      /* new */
143 #define PVR2_I_PLB_MASK                 0x01000000      /* new */
144 #define PVR2_INTERCONNECT               0x00800000      /* new */
145 #define PVR2_USE_EXTEND_FSL             0x00080000      /* new */
146 #define PVR2_USE_FSL_EXC                0x00040000      /* new */
147 #define PVR2_USE_MSR_INSTR              0x00020000
148 #define PVR2_USE_PCMP_INSTR             0x00010000
149 #define PVR2_AREA_OPTIMISED             0x00008000
150 #define PVR2_USE_BARREL_MASK            0x00004000
151 #define PVR2_USE_DIV_MASK               0x00002000
152 #define PVR2_USE_HW_MUL_MASK            0x00001000
153 #define PVR2_USE_FPU_MASK               0x00000800
154 #define PVR2_USE_MUL64_MASK             0x00000400
155 #define PVR2_USE_FPU2_MASK              0x00000200      /* new */
156 #define PVR2_USE_IPLBEXC                0x00000100
157 #define PVR2_USE_DPLBEXC                0x00000080
158 #define PVR2_OPCODE_0x0_ILL_MASK        0x00000040
159 #define PVR2_UNALIGNED_EXC_MASK         0x00000020
160 #define PVR2_ILL_OPCODE_EXC_MASK        0x00000010
161 #define PVR2_IOPB_BUS_EXC_MASK          0x00000008
162 #define PVR2_DOPB_BUS_EXC_MASK          0x00000004
163 #define PVR2_DIV_ZERO_EXC_MASK          0x00000002
164 #define PVR2_FPU_EXC_MASK               0x00000001
165 
166 /* Debug and exception PVR masks */
167 #define PVR3_DEBUG_ENABLED_MASK         0x80000000
168 #define PVR3_NUMBER_OF_PC_BRK_MASK      0x1E000000
169 #define PVR3_NUMBER_OF_RD_ADDR_BRK_MASK 0x00380000
170 #define PVR3_NUMBER_OF_WR_ADDR_BRK_MASK 0x0000E000
171 #define PVR3_FSL_LINKS_MASK             0x00000380
172 
173 /* ICache config PVR masks */
174 #define PVR4_USE_ICACHE_MASK            0x80000000
175 #define PVR4_ICACHE_ADDR_TAG_BITS_MASK  0x7C000000
176 #define PVR4_ICACHE_USE_FSL_MASK        0x02000000
177 #define PVR4_ICACHE_ALLOW_WR_MASK       0x01000000
178 #define PVR4_ICACHE_LINE_LEN_MASK       0x00E00000
179 #define PVR4_ICACHE_BYTE_SIZE_MASK      0x001F0000
180 
181 /* DCache config PVR masks */
182 #define PVR5_USE_DCACHE_MASK            0x80000000
183 #define PVR5_DCACHE_ADDR_TAG_BITS_MASK  0x7C000000
184 #define PVR5_DCACHE_USE_FSL_MASK        0x02000000
185 #define PVR5_DCACHE_ALLOW_WR_MASK       0x01000000
186 #define PVR5_DCACHE_LINE_LEN_MASK       0x00E00000
187 #define PVR5_DCACHE_BYTE_SIZE_MASK      0x001F0000
188 #define PVR5_DCACHE_WRITEBACK_MASK      0x00004000
189 
190 /* ICache base address PVR mask */
191 #define PVR6_ICACHE_BASEADDR_MASK       0xFFFFFFFF
192 
193 /* ICache high address PVR mask */
194 #define PVR7_ICACHE_HIGHADDR_MASK       0xFFFFFFFF
195 
196 /* DCache base address PVR mask */
197 #define PVR8_DCACHE_BASEADDR_MASK       0xFFFFFFFF
198 
199 /* DCache high address PVR mask */
200 #define PVR9_DCACHE_HIGHADDR_MASK       0xFFFFFFFF
201 
202 /* Target family PVR mask */
203 #define PVR10_TARGET_FAMILY_MASK        0xFF000000
204 #define PVR10_ASIZE_SHIFT               18
205 
206 /* MMU description */
207 #define PVR11_USE_MMU                   0xC0000000
208 #define PVR11_MMU_ITLB_SIZE             0x38000000
209 #define PVR11_MMU_DTLB_SIZE             0x07000000
210 #define PVR11_MMU_TLB_ACCESS            0x00C00000
211 #define PVR11_MMU_ZONES                 0x003E0000
212 /* MSR Reset value PVR mask */
213 #define PVR11_MSR_RESET_VALUE_MASK      0x000007FF
214 
215 #define C_PVR_NONE                      0
216 #define C_PVR_BASIC                     1
217 #define C_PVR_FULL                      2
218 
219 /* CPU flags.  */
220 
221 /* Condition codes.  */
222 #define CC_GE  5
223 #define CC_GT  4
224 #define CC_LE  3
225 #define CC_LT  2
226 #define CC_NE  1
227 #define CC_EQ  0
228 
229 #define STREAM_EXCEPTION (1 << 0)
230 #define STREAM_ATOMIC    (1 << 1)
231 #define STREAM_TEST      (1 << 2)
232 #define STREAM_CONTROL   (1 << 3)
233 #define STREAM_NONBLOCK  (1 << 4)
234 
235 #define TARGET_INSN_START_EXTRA_WORDS 1
236 
237 /* use-non-secure property masks */
238 #define USE_NON_SECURE_M_AXI_DP_MASK 0x1
239 #define USE_NON_SECURE_M_AXI_IP_MASK 0x2
240 #define USE_NON_SECURE_M_AXI_DC_MASK 0x4
241 #define USE_NON_SECURE_M_AXI_IC_MASK 0x8
242 
243 struct CPUArchState {
244     uint32_t bvalue;   /* TCG temporary, only valid during a TB */
245     uint32_t btarget;  /* Full resolved branch destination */
246 
247     uint32_t imm;
248     uint32_t regs[32];
249     uint32_t pc;
250     uint32_t msr;    /* All bits of MSR except MSR[C] and MSR[CC] */
251     uint32_t msr_c;  /* MSR[C], in low bit; other bits must be 0 */
252     target_ulong ear;
253     uint32_t esr;
254     uint32_t fsr;
255     uint32_t btr;
256     uint32_t edr;
257     float_status fp_status;
258     /* Stack protectors. Yes, it's a hw feature.  */
259     uint32_t slr, shr;
260 
261     /* lwx/swx reserved address */
262 #define RES_ADDR_NONE 0xffffffff /* Use 0xffffffff to indicate no reservation */
263     target_ulong res_addr;
264     uint32_t res_val;
265 
266     /* Internal flags.  */
267 #define IMM_FLAG        (1 << 0)
268 #define BIMM_FLAG       (1 << 1)
269 #define ESR_ESS_FLAG    (1 << 2)  /* indicates ESR_ESS_MASK is present */
270 /* MSR_EE               (1 << 8)  -- these 3 are not in iflags but tb_flags */
271 /* MSR_UM               (1 << 11) */
272 /* MSR_VM               (1 << 13) */
273 /* ESR_ESS_MASK         [11:5]    -- unwind into iflags for unaligned excp */
274 #define D_FLAG		(1 << 12)  /* Bit in ESR.  */
275 #define DRTI_FLAG	(1 << 16)
276 #define DRTE_FLAG	(1 << 17)
277 #define DRTB_FLAG	(1 << 18)
278 
279 /* TB dependent CPUMBState.  */
280 #define IFLAGS_TB_MASK  (D_FLAG | BIMM_FLAG | IMM_FLAG | \
281                          DRTI_FLAG | DRTE_FLAG | DRTB_FLAG)
282 #define MSR_TB_MASK     (MSR_UM | MSR_VM | MSR_EE)
283 
284     uint32_t iflags;
285 
286 #if !defined(CONFIG_USER_ONLY)
287     /* Unified MMU.  */
288     MicroBlazeMMU mmu;
289 #endif
290 
291     /* Fields up to this point are cleared by a CPU reset */
292     struct {} end_reset_fields;
293 
294     /* These fields are preserved on reset.  */
295 };
296 
297 /*
298  * Microblaze Configuration Settings
299  *
300  * Note that the structure is sorted by type and size to minimize holes.
301  */
302 typedef struct {
303     char *version;
304 
305     uint64_t addr_mask;
306 
307     uint32_t base_vectors;
308     uint32_t pvr_user2;
309     uint32_t pvr_regs[13];
310 
311     uint8_t addr_size;
312     uint8_t use_fpu;
313     uint8_t use_hw_mul;
314     uint8_t pvr_user1;
315     uint8_t pvr;
316     uint8_t mmu;
317     uint8_t mmu_tlb_access;
318     uint8_t mmu_zones;
319 
320     bool stackprot;
321     bool use_barrel;
322     bool use_div;
323     bool use_msr_instr;
324     bool use_pcmp_instr;
325     bool use_mmu;
326     uint8_t use_non_secure;
327     bool dcache_writeback;
328     bool endi;
329     bool dopb_bus_exception;
330     bool iopb_bus_exception;
331     bool illegal_opcode_exception;
332     bool opcode_0_illegal;
333     bool div_zero_exception;
334     bool unaligned_exceptions;
335 } MicroBlazeCPUConfig;
336 
337 /**
338  * MicroBlazeCPU:
339  * @env: #CPUMBState
340  *
341  * A MicroBlaze CPU.
342  */
343 struct ArchCPU {
344     CPUState parent_obj;
345 
346     CPUMBState env;
347 
348     bool ns_axi_dp;
349     bool ns_axi_ip;
350     bool ns_axi_dc;
351     bool ns_axi_ic;
352 
353     MicroBlazeCPUConfig cfg;
354 };
355 
356 /**
357  * MicroBlazeCPUClass:
358  * @parent_realize: The parent class' realize handler.
359  * @parent_phases: The parent class' reset phase handlers.
360  *
361  * A MicroBlaze CPU model.
362  */
363 struct MicroBlazeCPUClass {
364     CPUClass parent_class;
365 
366     DeviceRealize parent_realize;
367     ResettablePhases parent_phases;
368 };
369 
370 #ifndef CONFIG_USER_ONLY
371 void mb_cpu_do_interrupt(CPUState *cs);
372 bool mb_cpu_exec_interrupt(CPUState *cs, int int_req);
373 hwaddr mb_cpu_get_phys_page_attrs_debug(CPUState *cpu, vaddr addr,
374                                         MemTxAttrs *attrs);
375 #endif /* !CONFIG_USER_ONLY */
376 G_NORETURN void mb_cpu_do_unaligned_access(CPUState *cs, vaddr vaddr,
377                                            MMUAccessType access_type,
378                                            int mmu_idx, uintptr_t retaddr);
379 void mb_cpu_dump_state(CPUState *cpu, FILE *f, int flags);
380 int mb_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
381 int mb_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
382 int mb_cpu_gdb_read_stack_protect(CPUState *cs, GByteArray *buf, int reg);
383 int mb_cpu_gdb_write_stack_protect(CPUState *cs, uint8_t *buf, int reg);
384 
385 static inline uint32_t mb_cpu_read_msr(const CPUMBState *env)
386 {
387     /* Replicate MSR[C] to MSR[CC]. */
388     return env->msr | (env->msr_c * (MSR_C | MSR_CC));
389 }
390 
391 static inline void mb_cpu_write_msr(CPUMBState *env, uint32_t val)
392 {
393     env->msr_c = (val >> 2) & 1;
394     /*
395      * Clear both MSR[C] and MSR[CC] from the saved copy.
396      * MSR_PVR is not writable and is always clear.
397      */
398     env->msr = val & ~(MSR_C | MSR_CC | MSR_PVR);
399 }
400 
401 void mb_tcg_init(void);
402 void mb_translate_code(CPUState *cs, TranslationBlock *tb,
403                        int *max_insns, vaddr pc, void *host_pc);
404 
405 #define CPU_RESOLVING_TYPE TYPE_MICROBLAZE_CPU
406 
407 /* MMU modes definitions */
408 #define MMU_NOMMU_IDX   0
409 #define MMU_KERNEL_IDX  1
410 #define MMU_USER_IDX    2
411 /* See NB_MMU_MODES in cpu-defs.h. */
412 
413 #include "exec/cpu-all.h"
414 
415 /* Ensure there is no overlap between the two masks. */
416 QEMU_BUILD_BUG_ON(MSR_TB_MASK & IFLAGS_TB_MASK);
417 
418 static inline bool mb_cpu_is_big_endian(CPUState *cs)
419 {
420     MicroBlazeCPU *cpu = MICROBLAZE_CPU(cs);
421 
422     return !cpu->cfg.endi;
423 }
424 
425 static inline void cpu_get_tb_cpu_state(CPUMBState *env, vaddr *pc,
426                                         uint64_t *cs_base, uint32_t *flags)
427 {
428     *pc = env->pc;
429     *flags = (env->iflags & IFLAGS_TB_MASK) | (env->msr & MSR_TB_MASK);
430     *cs_base = (*flags & IMM_FLAG ? env->imm : 0);
431 }
432 
433 #if !defined(CONFIG_USER_ONLY)
434 bool mb_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
435                      MMUAccessType access_type, int mmu_idx,
436                      bool probe, uintptr_t retaddr);
437 
438 void mb_cpu_transaction_failed(CPUState *cs, hwaddr physaddr, vaddr addr,
439                                unsigned size, MMUAccessType access_type,
440                                int mmu_idx, MemTxAttrs attrs,
441                                MemTxResult response, uintptr_t retaddr);
442 #endif
443 
444 #ifndef CONFIG_USER_ONLY
445 extern const VMStateDescription vmstate_mb_cpu;
446 #endif
447 
448 #endif
449