xref: /openbmc/qemu/target/xtensa/cpu.h (revision 503bb0b9) 
1 /*
2  * Copyright (c) 2011, Max Filippov, Open Source and Linux Lab.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of the Open Source and Linux Lab nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef XTENSA_CPU_H
29 #define XTENSA_CPU_H
30 
31 #define ALIGNED_ONLY
32 #define TARGET_LONG_BITS 32
33 
34 /* Xtensa processors have a weak memory model */
35 #define TCG_GUEST_DEFAULT_MO      (0)
36 
37 #define CPUArchState struct CPUXtensaState
38 
39 #include "qemu-common.h"
40 #include "cpu-qom.h"
41 #include "exec/cpu-defs.h"
42 #include "xtensa-isa.h"
43 
44 #define NB_MMU_MODES 4
45 
46 #define TARGET_PHYS_ADDR_SPACE_BITS 32
47 #ifdef CONFIG_USER_ONLY
48 #define TARGET_VIRT_ADDR_SPACE_BITS 30
49 #else
50 #define TARGET_VIRT_ADDR_SPACE_BITS 32
51 #endif
52 #define TARGET_PAGE_BITS 12
53 
54 enum {
55     /* Additional instructions */
56     XTENSA_OPTION_CODE_DENSITY,
57     XTENSA_OPTION_LOOP,
58     XTENSA_OPTION_EXTENDED_L32R,
59     XTENSA_OPTION_16_BIT_IMUL,
60     XTENSA_OPTION_32_BIT_IMUL,
61     XTENSA_OPTION_32_BIT_IMUL_HIGH,
62     XTENSA_OPTION_32_BIT_IDIV,
63     XTENSA_OPTION_MAC16,
64     XTENSA_OPTION_MISC_OP_NSA,
65     XTENSA_OPTION_MISC_OP_MINMAX,
66     XTENSA_OPTION_MISC_OP_SEXT,
67     XTENSA_OPTION_MISC_OP_CLAMPS,
68     XTENSA_OPTION_COPROCESSOR,
69     XTENSA_OPTION_BOOLEAN,
70     XTENSA_OPTION_FP_COPROCESSOR,
71     XTENSA_OPTION_MP_SYNCHRO,
72     XTENSA_OPTION_CONDITIONAL_STORE,
73     XTENSA_OPTION_ATOMCTL,
74     XTENSA_OPTION_DEPBITS,
75 
76     /* Interrupts and exceptions */
77     XTENSA_OPTION_EXCEPTION,
78     XTENSA_OPTION_RELOCATABLE_VECTOR,
79     XTENSA_OPTION_UNALIGNED_EXCEPTION,
80     XTENSA_OPTION_INTERRUPT,
81     XTENSA_OPTION_HIGH_PRIORITY_INTERRUPT,
82     XTENSA_OPTION_TIMER_INTERRUPT,
83 
84     /* Local memory */
85     XTENSA_OPTION_ICACHE,
86     XTENSA_OPTION_ICACHE_TEST,
87     XTENSA_OPTION_ICACHE_INDEX_LOCK,
88     XTENSA_OPTION_DCACHE,
89     XTENSA_OPTION_DCACHE_TEST,
90     XTENSA_OPTION_DCACHE_INDEX_LOCK,
91     XTENSA_OPTION_IRAM,
92     XTENSA_OPTION_IROM,
93     XTENSA_OPTION_DRAM,
94     XTENSA_OPTION_DROM,
95     XTENSA_OPTION_XLMI,
96     XTENSA_OPTION_HW_ALIGNMENT,
97     XTENSA_OPTION_MEMORY_ECC_PARITY,
98 
99     /* Memory protection and translation */
100     XTENSA_OPTION_REGION_PROTECTION,
101     XTENSA_OPTION_REGION_TRANSLATION,
102     XTENSA_OPTION_MMU,
103     XTENSA_OPTION_CACHEATTR,
104 
105     /* Other */
106     XTENSA_OPTION_WINDOWED_REGISTER,
107     XTENSA_OPTION_PROCESSOR_INTERFACE,
108     XTENSA_OPTION_MISC_SR,
109     XTENSA_OPTION_THREAD_POINTER,
110     XTENSA_OPTION_PROCESSOR_ID,
111     XTENSA_OPTION_DEBUG,
112     XTENSA_OPTION_TRACE_PORT,
113     XTENSA_OPTION_EXTERN_REGS,
114 };
115 
116 enum {
117     EXPSTATE = 230,
118     THREADPTR = 231,
119     FCR = 232,
120     FSR = 233,
121 };
122 
123 enum {
124     LBEG = 0,
125     LEND = 1,
126     LCOUNT = 2,
127     SAR = 3,
128     BR = 4,
129     LITBASE = 5,
130     SCOMPARE1 = 12,
131     ACCLO = 16,
132     ACCHI = 17,
133     MR = 32,
134     WINDOW_BASE = 72,
135     WINDOW_START = 73,
136     PTEVADDR = 83,
137     MMID = 89,
138     RASID = 90,
139     ITLBCFG = 91,
140     DTLBCFG = 92,
141     IBREAKENABLE = 96,
142     MEMCTL = 97,
143     CACHEATTR = 98,
144     ATOMCTL = 99,
145     DDR = 104,
146     IBREAKA = 128,
147     DBREAKA = 144,
148     DBREAKC = 160,
149     CONFIGID0 = 176,
150     EPC1 = 177,
151     DEPC = 192,
152     EPS2 = 194,
153     CONFIGID1 = 208,
154     EXCSAVE1 = 209,
155     CPENABLE = 224,
156     INTSET = 226,
157     INTCLEAR = 227,
158     INTENABLE = 228,
159     PS = 230,
160     VECBASE = 231,
161     EXCCAUSE = 232,
162     DEBUGCAUSE = 233,
163     CCOUNT = 234,
164     PRID = 235,
165     ICOUNT = 236,
166     ICOUNTLEVEL = 237,
167     EXCVADDR = 238,
168     CCOMPARE = 240,
169     MISC = 244,
170 };
171 
172 #define PS_INTLEVEL 0xf
173 #define PS_INTLEVEL_SHIFT 0
174 
175 #define PS_EXCM 0x10
176 #define PS_UM 0x20
177 
178 #define PS_RING 0xc0
179 #define PS_RING_SHIFT 6
180 
181 #define PS_OWB 0xf00
182 #define PS_OWB_SHIFT 8
183 #define PS_OWB_LEN 4
184 
185 #define PS_CALLINC 0x30000
186 #define PS_CALLINC_SHIFT 16
187 #define PS_CALLINC_LEN 2
188 
189 #define PS_WOE 0x40000
190 
191 #define DEBUGCAUSE_IC 0x1
192 #define DEBUGCAUSE_IB 0x2
193 #define DEBUGCAUSE_DB 0x4
194 #define DEBUGCAUSE_BI 0x8
195 #define DEBUGCAUSE_BN 0x10
196 #define DEBUGCAUSE_DI 0x20
197 #define DEBUGCAUSE_DBNUM 0xf00
198 #define DEBUGCAUSE_DBNUM_SHIFT 8
199 
200 #define DBREAKC_SB 0x80000000
201 #define DBREAKC_LB 0x40000000
202 #define DBREAKC_SB_LB (DBREAKC_SB | DBREAKC_LB)
203 #define DBREAKC_MASK 0x3f
204 
205 #define MEMCTL_INIT 0x00800000
206 #define MEMCTL_IUSEWAYS_SHIFT 18
207 #define MEMCTL_IUSEWAYS_LEN 5
208 #define MEMCTL_IUSEWAYS_MASK 0x007c0000
209 #define MEMCTL_DALLOCWAYS_SHIFT 13
210 #define MEMCTL_DALLOCWAYS_LEN 5
211 #define MEMCTL_DALLOCWAYS_MASK 0x0003e000
212 #define MEMCTL_DUSEWAYS_SHIFT 8
213 #define MEMCTL_DUSEWAYS_LEN 5
214 #define MEMCTL_DUSEWAYS_MASK 0x00001f00
215 #define MEMCTL_ISNP 0x4
216 #define MEMCTL_DSNP 0x2
217 #define MEMCTL_IL0EN 0x1
218 
219 #define MAX_INSN_LENGTH 64
220 #define MAX_INSN_SLOTS 32
221 #define MAX_OPCODE_ARGS 16
222 #define MAX_NAREG 64
223 #define MAX_NINTERRUPT 32
224 #define MAX_NLEVEL 6
225 #define MAX_NNMI 1
226 #define MAX_NCCOMPARE 3
227 #define MAX_TLB_WAY_SIZE 8
228 #define MAX_NDBREAK 2
229 #define MAX_NMEMORY 4
230 
231 #define REGION_PAGE_MASK 0xe0000000
232 
233 #define PAGE_CACHE_MASK    0x700
234 #define PAGE_CACHE_SHIFT   8
235 #define PAGE_CACHE_INVALID 0x000
236 #define PAGE_CACHE_BYPASS  0x100
237 #define PAGE_CACHE_WT      0x200
238 #define PAGE_CACHE_WB      0x400
239 #define PAGE_CACHE_ISOLATE 0x600
240 
241 enum {
242     /* Static vectors */
243     EXC_RESET0,
244     EXC_RESET1,
245     EXC_MEMORY_ERROR,
246 
247     /* Dynamic vectors */
248     EXC_WINDOW_OVERFLOW4,
249     EXC_WINDOW_UNDERFLOW4,
250     EXC_WINDOW_OVERFLOW8,
251     EXC_WINDOW_UNDERFLOW8,
252     EXC_WINDOW_OVERFLOW12,
253     EXC_WINDOW_UNDERFLOW12,
254     EXC_IRQ,
255     EXC_KERNEL,
256     EXC_USER,
257     EXC_DOUBLE,
258     EXC_DEBUG,
259     EXC_MAX
260 };
261 
262 enum {
263     ILLEGAL_INSTRUCTION_CAUSE = 0,
264     SYSCALL_CAUSE,
265     INSTRUCTION_FETCH_ERROR_CAUSE,
266     LOAD_STORE_ERROR_CAUSE,
267     LEVEL1_INTERRUPT_CAUSE,
268     ALLOCA_CAUSE,
269     INTEGER_DIVIDE_BY_ZERO_CAUSE,
270     PRIVILEGED_CAUSE = 8,
271     LOAD_STORE_ALIGNMENT_CAUSE,
272 
273     INSTR_PIF_DATA_ERROR_CAUSE = 12,
274     LOAD_STORE_PIF_DATA_ERROR_CAUSE,
275     INSTR_PIF_ADDR_ERROR_CAUSE,
276     LOAD_STORE_PIF_ADDR_ERROR_CAUSE,
277 
278     INST_TLB_MISS_CAUSE,
279     INST_TLB_MULTI_HIT_CAUSE,
280     INST_FETCH_PRIVILEGE_CAUSE,
281     INST_FETCH_PROHIBITED_CAUSE = 20,
282     LOAD_STORE_TLB_MISS_CAUSE = 24,
283     LOAD_STORE_TLB_MULTI_HIT_CAUSE,
284     LOAD_STORE_PRIVILEGE_CAUSE,
285     LOAD_PROHIBITED_CAUSE = 28,
286     STORE_PROHIBITED_CAUSE,
287 
288     COPROCESSOR0_DISABLED = 32,
289 };
290 
291 typedef enum {
292     INTTYPE_LEVEL,
293     INTTYPE_EDGE,
294     INTTYPE_NMI,
295     INTTYPE_SOFTWARE,
296     INTTYPE_TIMER,
297     INTTYPE_DEBUG,
298     INTTYPE_WRITE_ERR,
299     INTTYPE_PROFILING,
300     INTTYPE_MAX
301 } interrupt_type;
302 
303 struct CPUXtensaState;
304 
305 typedef struct xtensa_tlb_entry {
306     uint32_t vaddr;
307     uint32_t paddr;
308     uint8_t asid;
309     uint8_t attr;
310     bool variable;
311 } xtensa_tlb_entry;
312 
313 typedef struct xtensa_tlb {
314     unsigned nways;
315     const unsigned way_size[10];
316     bool varway56;
317     unsigned nrefillentries;
318 } xtensa_tlb;
319 
320 typedef struct XtensaGdbReg {
321     int targno;
322     unsigned flags;
323     int type;
324     int group;
325     unsigned size;
326 } XtensaGdbReg;
327 
328 typedef struct XtensaGdbRegmap {
329     int num_regs;
330     int num_core_regs;
331     /* PC + a + ar + sr + ur */
332     XtensaGdbReg reg[1 + 16 + 64 + 256 + 256];
333 } XtensaGdbRegmap;
334 
335 typedef struct XtensaCcompareTimer {
336     struct CPUXtensaState *env;
337     QEMUTimer *timer;
338 } XtensaCcompareTimer;
339 
340 typedef struct XtensaMemory {
341     unsigned num;
342     struct XtensaMemoryRegion {
343         uint32_t addr;
344         uint32_t size;
345     } location[MAX_NMEMORY];
346 } XtensaMemory;
347 
348 typedef struct DisasContext DisasContext;
349 typedef void (*XtensaOpcodeOp)(DisasContext *dc, const uint32_t arg[],
350                                const uint32_t par[]);
351 typedef bool (*XtensaOpcodeBoolTest)(DisasContext *dc,
352                                      const uint32_t arg[],
353                                      const uint32_t par[]);
354 typedef uint32_t (*XtensaOpcodeUintTest)(DisasContext *dc,
355                                          const uint32_t arg[],
356                                          const uint32_t par[]);
357 
358 enum {
359     XTENSA_OP_ILL = 0x1,
360     XTENSA_OP_PRIVILEGED = 0x2,
361     XTENSA_OP_SYSCALL = 0x4,
362     XTENSA_OP_DEBUG_BREAK = 0x8,
363 
364     XTENSA_OP_OVERFLOW = 0x10,
365     XTENSA_OP_UNDERFLOW = 0x20,
366     XTENSA_OP_ALLOCA = 0x40,
367     XTENSA_OP_COPROCESSOR = 0x80,
368 
369     XTENSA_OP_DIVIDE_BY_ZERO = 0x100,
370 
371     XTENSA_OP_CHECK_INTERRUPTS = 0x200,
372     XTENSA_OP_EXIT_TB_M1 = 0x400,
373     XTENSA_OP_EXIT_TB_0 = 0x800,
374 };
375 
376 typedef struct XtensaOpcodeOps {
377     const char *name;
378     XtensaOpcodeOp translate;
379     XtensaOpcodeBoolTest test_ill;
380     XtensaOpcodeUintTest test_overflow;
381     const uint32_t *par;
382     uint32_t op_flags;
383     uint32_t windowed_register_op;
384     uint32_t coprocessor;
385 } XtensaOpcodeOps;
386 
387 typedef struct XtensaOpcodeTranslators {
388     unsigned num_opcodes;
389     const XtensaOpcodeOps *opcode;
390 } XtensaOpcodeTranslators;
391 
392 extern const XtensaOpcodeTranslators xtensa_core_opcodes;
393 extern const XtensaOpcodeTranslators xtensa_fpu2000_opcodes;
394 
395 struct XtensaConfig {
396     const char *name;
397     uint64_t options;
398     XtensaGdbRegmap gdb_regmap;
399     unsigned nareg;
400     int excm_level;
401     int ndepc;
402     unsigned inst_fetch_width;
403     unsigned max_insn_size;
404     uint32_t vecbase;
405     uint32_t exception_vector[EXC_MAX];
406     unsigned ninterrupt;
407     unsigned nlevel;
408     uint32_t interrupt_vector[MAX_NLEVEL + MAX_NNMI + 1];
409     uint32_t level_mask[MAX_NLEVEL + MAX_NNMI + 1];
410     uint32_t inttype_mask[INTTYPE_MAX];
411     struct {
412         uint32_t level;
413         interrupt_type inttype;
414     } interrupt[MAX_NINTERRUPT];
415     unsigned nccompare;
416     uint32_t timerint[MAX_NCCOMPARE];
417     unsigned nextint;
418     unsigned extint[MAX_NINTERRUPT];
419 
420     unsigned debug_level;
421     unsigned nibreak;
422     unsigned ndbreak;
423 
424     unsigned icache_ways;
425     unsigned dcache_ways;
426     uint32_t memctl_mask;
427 
428     XtensaMemory instrom;
429     XtensaMemory instram;
430     XtensaMemory datarom;
431     XtensaMemory dataram;
432     XtensaMemory sysrom;
433     XtensaMemory sysram;
434 
435     uint32_t configid[2];
436 
437     void *isa_internal;
438     xtensa_isa isa;
439     XtensaOpcodeOps **opcode_ops;
440     const XtensaOpcodeTranslators **opcode_translators;
441 
442     uint32_t clock_freq_khz;
443 
444     xtensa_tlb itlb;
445     xtensa_tlb dtlb;
446 };
447 
448 typedef struct XtensaConfigList {
449     const XtensaConfig *config;
450     struct XtensaConfigList *next;
451 } XtensaConfigList;
452 
453 #ifdef HOST_WORDS_BIGENDIAN
454 enum {
455     FP_F32_HIGH,
456     FP_F32_LOW,
457 };
458 #else
459 enum {
460     FP_F32_LOW,
461     FP_F32_HIGH,
462 };
463 #endif
464 
465 typedef struct CPUXtensaState {
466     const XtensaConfig *config;
467     uint32_t regs[16];
468     uint32_t pc;
469     uint32_t sregs[256];
470     uint32_t uregs[256];
471     uint32_t phys_regs[MAX_NAREG];
472     union {
473         float32 f32[2];
474         float64 f64;
475     } fregs[16];
476     float_status fp_status;
477 
478 #ifndef CONFIG_USER_ONLY
479     xtensa_tlb_entry itlb[7][MAX_TLB_WAY_SIZE];
480     xtensa_tlb_entry dtlb[10][MAX_TLB_WAY_SIZE];
481     unsigned autorefill_idx;
482     bool runstall;
483     AddressSpace *address_space_er;
484     MemoryRegion *system_er;
485     int pending_irq_level; /* level of last raised IRQ */
486     qemu_irq *irq_inputs;
487     qemu_irq ext_irq_inputs[MAX_NINTERRUPT];
488     qemu_irq runstall_irq;
489     XtensaCcompareTimer ccompare[MAX_NCCOMPARE];
490     uint64_t time_base;
491     uint64_t ccount_time;
492     uint32_t ccount_base;
493 #endif
494 
495     int exception_taken;
496     int yield_needed;
497     unsigned static_vectors;
498 
499     /* Watchpoints for DBREAK registers */
500     struct CPUWatchpoint *cpu_watchpoint[MAX_NDBREAK];
501 
502     CPU_COMMON
503 } CPUXtensaState;
504 
505 /**
506  * XtensaCPU:
507  * @env: #CPUXtensaState
508  *
509  * An Xtensa CPU.
510  */
511 struct XtensaCPU {
512     /*< private >*/
513     CPUState parent_obj;
514     /*< public >*/
515 
516     CPUXtensaState env;
517 };
518 
519 static inline XtensaCPU *xtensa_env_get_cpu(const CPUXtensaState *env)
520 {
521     return container_of(env, XtensaCPU, env);
522 }
523 
524 #define ENV_GET_CPU(e) CPU(xtensa_env_get_cpu(e))
525 
526 #define ENV_OFFSET offsetof(XtensaCPU, env)
527 
528 
529 int xtensa_cpu_handle_mmu_fault(CPUState *cs, vaddr address, int rw, int size,
530                                 int mmu_idx);
531 void xtensa_cpu_do_interrupt(CPUState *cpu);
532 bool xtensa_cpu_exec_interrupt(CPUState *cpu, int interrupt_request);
533 void xtensa_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr, vaddr addr,
534                                       unsigned size, MMUAccessType access_type,
535                                       int mmu_idx, MemTxAttrs attrs,
536                                       MemTxResult response, uintptr_t retaddr);
537 void xtensa_cpu_dump_state(CPUState *cpu, FILE *f,
538                            fprintf_function cpu_fprintf, int flags);
539 hwaddr xtensa_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
540 void xtensa_count_regs(const XtensaConfig *config,
541                        unsigned *n_regs, unsigned *n_core_regs);
542 int xtensa_cpu_gdb_read_register(CPUState *cpu, uint8_t *buf, int reg);
543 int xtensa_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
544 void xtensa_cpu_do_unaligned_access(CPUState *cpu, vaddr addr,
545                                     MMUAccessType access_type,
546                                     int mmu_idx, uintptr_t retaddr);
547 
548 #define cpu_signal_handler cpu_xtensa_signal_handler
549 #define cpu_list xtensa_cpu_list
550 
551 #define XTENSA_CPU_TYPE_SUFFIX "-" TYPE_XTENSA_CPU
552 #define XTENSA_CPU_TYPE_NAME(model) model XTENSA_CPU_TYPE_SUFFIX
553 #define CPU_RESOLVING_TYPE TYPE_XTENSA_CPU
554 
555 #ifdef TARGET_WORDS_BIGENDIAN
556 #define XTENSA_DEFAULT_CPU_MODEL "fsf"
557 #define XTENSA_DEFAULT_CPU_NOMMU_MODEL "fsf"
558 #else
559 #define XTENSA_DEFAULT_CPU_MODEL "dc232b"
560 #define XTENSA_DEFAULT_CPU_NOMMU_MODEL "de212"
561 #endif
562 #define XTENSA_DEFAULT_CPU_TYPE \
563     XTENSA_CPU_TYPE_NAME(XTENSA_DEFAULT_CPU_MODEL)
564 #define XTENSA_DEFAULT_CPU_NOMMU_TYPE \
565     XTENSA_CPU_TYPE_NAME(XTENSA_DEFAULT_CPU_NOMMU_MODEL)
566 
567 void xtensa_translate_init(void);
568 void xtensa_breakpoint_handler(CPUState *cs);
569 void xtensa_finalize_config(XtensaConfig *config);
570 void xtensa_register_core(XtensaConfigList *node);
571 void xtensa_sim_open_console(Chardev *chr);
572 void check_interrupts(CPUXtensaState *s);
573 void xtensa_irq_init(CPUXtensaState *env);
574 qemu_irq *xtensa_get_extints(CPUXtensaState *env);
575 qemu_irq xtensa_get_runstall(CPUXtensaState *env);
576 int cpu_xtensa_signal_handler(int host_signum, void *pinfo, void *puc);
577 void xtensa_cpu_list(FILE *f, fprintf_function cpu_fprintf);
578 void xtensa_sync_window_from_phys(CPUXtensaState *env);
579 void xtensa_sync_phys_from_window(CPUXtensaState *env);
580 void xtensa_rotate_window(CPUXtensaState *env, uint32_t delta);
581 void xtensa_restore_owb(CPUXtensaState *env);
582 void debug_exception_env(CPUXtensaState *new_env, uint32_t cause);
583 
584 static inline void xtensa_select_static_vectors(CPUXtensaState *env,
585                                                 unsigned n)
586 {
587     assert(n < 2);
588     env->static_vectors = n;
589 }
590 void xtensa_runstall(CPUXtensaState *env, bool runstall);
591 XtensaOpcodeOps *xtensa_find_opcode_ops(const XtensaOpcodeTranslators *t,
592                                         const char *opcode);
593 
594 #define XTENSA_OPTION_BIT(opt) (((uint64_t)1) << (opt))
595 #define XTENSA_OPTION_ALL (~(uint64_t)0)
596 
597 static inline bool xtensa_option_bits_enabled(const XtensaConfig *config,
598         uint64_t opt)
599 {
600     return (config->options & opt) != 0;
601 }
602 
603 static inline bool xtensa_option_enabled(const XtensaConfig *config, int opt)
604 {
605     return xtensa_option_bits_enabled(config, XTENSA_OPTION_BIT(opt));
606 }
607 
608 static inline int xtensa_get_cintlevel(const CPUXtensaState *env)
609 {
610     int level = (env->sregs[PS] & PS_INTLEVEL) >> PS_INTLEVEL_SHIFT;
611     if ((env->sregs[PS] & PS_EXCM) && env->config->excm_level > level) {
612         level = env->config->excm_level;
613     }
614     return level;
615 }
616 
617 static inline int xtensa_get_ring(const CPUXtensaState *env)
618 {
619     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU)) {
620         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
621     } else {
622         return 0;
623     }
624 }
625 
626 static inline int xtensa_get_cring(const CPUXtensaState *env)
627 {
628     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU) &&
629             (env->sregs[PS] & PS_EXCM) == 0) {
630         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
631     } else {
632         return 0;
633     }
634 }
635 
636 #ifndef CONFIG_USER_ONLY
637 uint32_t xtensa_tlb_get_addr_mask(const CPUXtensaState *env,
638                                   bool dtlb, uint32_t way);
639 void split_tlb_entry_spec_way(const CPUXtensaState *env, uint32_t v, bool dtlb,
640         uint32_t *vpn, uint32_t wi, uint32_t *ei);
641 int xtensa_tlb_lookup(const CPUXtensaState *env, uint32_t addr, bool dtlb,
642         uint32_t *pwi, uint32_t *pei, uint8_t *pring);
643 void xtensa_tlb_set_entry_mmu(const CPUXtensaState *env,
644         xtensa_tlb_entry *entry, bool dtlb,
645         unsigned wi, unsigned ei, uint32_t vpn, uint32_t pte);
646 void xtensa_tlb_set_entry(CPUXtensaState *env, bool dtlb,
647         unsigned wi, unsigned ei, uint32_t vpn, uint32_t pte);
648 int xtensa_get_physical_addr(CPUXtensaState *env, bool update_tlb,
649         uint32_t vaddr, int is_write, int mmu_idx,
650         uint32_t *paddr, uint32_t *page_size, unsigned *access);
651 void reset_mmu(CPUXtensaState *env);
652 void dump_mmu(FILE *f, fprintf_function cpu_fprintf, CPUXtensaState *env);
653 
654 static inline MemoryRegion *xtensa_get_er_region(CPUXtensaState *env)
655 {
656     return env->system_er;
657 }
658 
659 static inline xtensa_tlb_entry *xtensa_tlb_get_entry(CPUXtensaState *env,
660         bool dtlb, unsigned wi, unsigned ei)
661 {
662     return dtlb ?
663         env->dtlb[wi] + ei :
664         env->itlb[wi] + ei;
665 }
666 #endif
667 
668 static inline uint32_t xtensa_replicate_windowstart(CPUXtensaState *env)
669 {
670     return env->sregs[WINDOW_START] |
671         (env->sregs[WINDOW_START] << env->config->nareg / 4);
672 }
673 
674 /* MMU modes definitions */
675 #define MMU_MODE0_SUFFIX _ring0
676 #define MMU_MODE1_SUFFIX _ring1
677 #define MMU_MODE2_SUFFIX _ring2
678 #define MMU_MODE3_SUFFIX _ring3
679 #define MMU_USER_IDX 3
680 
681 static inline int cpu_mmu_index(CPUXtensaState *env, bool ifetch)
682 {
683     return xtensa_get_cring(env);
684 }
685 
686 #define XTENSA_TBFLAG_RING_MASK 0x3
687 #define XTENSA_TBFLAG_EXCM 0x4
688 #define XTENSA_TBFLAG_LITBASE 0x8
689 #define XTENSA_TBFLAG_DEBUG 0x10
690 #define XTENSA_TBFLAG_ICOUNT 0x20
691 #define XTENSA_TBFLAG_CPENABLE_MASK 0x3fc0
692 #define XTENSA_TBFLAG_CPENABLE_SHIFT 6
693 #define XTENSA_TBFLAG_EXCEPTION 0x4000
694 #define XTENSA_TBFLAG_WINDOW_MASK 0x18000
695 #define XTENSA_TBFLAG_WINDOW_SHIFT 15
696 #define XTENSA_TBFLAG_YIELD 0x20000
697 #define XTENSA_TBFLAG_CWOE 0x40000
698 #define XTENSA_TBFLAG_CALLINC_MASK 0x180000
699 #define XTENSA_TBFLAG_CALLINC_SHIFT 19
700 
701 #define XTENSA_CSBASE_LEND_MASK 0x0000ffff
702 #define XTENSA_CSBASE_LEND_SHIFT 0
703 #define XTENSA_CSBASE_LBEG_OFF_MASK 0x00ff0000
704 #define XTENSA_CSBASE_LBEG_OFF_SHIFT 16
705 
706 static inline void cpu_get_tb_cpu_state(CPUXtensaState *env, target_ulong *pc,
707         target_ulong *cs_base, uint32_t *flags)
708 {
709     CPUState *cs = CPU(xtensa_env_get_cpu(env));
710 
711     *pc = env->pc;
712     *cs_base = 0;
713     *flags = 0;
714     *flags |= xtensa_get_ring(env);
715     if (env->sregs[PS] & PS_EXCM) {
716         *flags |= XTENSA_TBFLAG_EXCM;
717     } else if (xtensa_option_enabled(env->config, XTENSA_OPTION_LOOP)) {
718         target_ulong lend_dist =
719             env->sregs[LEND] - (env->pc & -(1u << TARGET_PAGE_BITS));
720 
721         /*
722          * 0 in the csbase_lend field means that there may not be a loopback
723          * for any instruction that starts inside this page. Any other value
724          * means that an instruction that ends at this offset from the page
725          * start may loop back and will need loopback code to be generated.
726          *
727          * lend_dist is 0 when LEND points to the start of the page, but
728          * no instruction that starts inside this page may end at offset 0,
729          * so it's still correct.
730          *
731          * When an instruction ends at a page boundary it may only start in
732          * the previous page. lend_dist will be encoded as TARGET_PAGE_SIZE
733          * for the TB that contains this instruction.
734          */
735         if (lend_dist < (1u << TARGET_PAGE_BITS) + env->config->max_insn_size) {
736             target_ulong lbeg_off = env->sregs[LEND] - env->sregs[LBEG];
737 
738             *cs_base = lend_dist;
739             if (lbeg_off < 256) {
740                 *cs_base |= lbeg_off << XTENSA_CSBASE_LBEG_OFF_SHIFT;
741             }
742         }
743     }
744     if (xtensa_option_enabled(env->config, XTENSA_OPTION_EXTENDED_L32R) &&
745             (env->sregs[LITBASE] & 1)) {
746         *flags |= XTENSA_TBFLAG_LITBASE;
747     }
748     if (xtensa_option_enabled(env->config, XTENSA_OPTION_DEBUG)) {
749         if (xtensa_get_cintlevel(env) < env->config->debug_level) {
750             *flags |= XTENSA_TBFLAG_DEBUG;
751         }
752         if (xtensa_get_cintlevel(env) < env->sregs[ICOUNTLEVEL]) {
753             *flags |= XTENSA_TBFLAG_ICOUNT;
754         }
755     }
756     if (xtensa_option_enabled(env->config, XTENSA_OPTION_COPROCESSOR)) {
757         *flags |= env->sregs[CPENABLE] << XTENSA_TBFLAG_CPENABLE_SHIFT;
758     }
759     if (cs->singlestep_enabled && env->exception_taken) {
760         *flags |= XTENSA_TBFLAG_EXCEPTION;
761     }
762     if (xtensa_option_enabled(env->config, XTENSA_OPTION_WINDOWED_REGISTER) &&
763         (env->sregs[PS] & (PS_WOE | PS_EXCM)) == PS_WOE) {
764         uint32_t windowstart = xtensa_replicate_windowstart(env) >>
765             (env->sregs[WINDOW_BASE] + 1);
766         uint32_t w = ctz32(windowstart | 0x8);
767 
768         *flags |= (w << XTENSA_TBFLAG_WINDOW_SHIFT) | XTENSA_TBFLAG_CWOE;
769         *flags |= extract32(env->sregs[PS], PS_CALLINC_SHIFT,
770                             PS_CALLINC_LEN) << XTENSA_TBFLAG_CALLINC_SHIFT;
771     } else {
772         *flags |= 3 << XTENSA_TBFLAG_WINDOW_SHIFT;
773     }
774     if (env->yield_needed) {
775         *flags |= XTENSA_TBFLAG_YIELD;
776     }
777 }
778 
779 #include "exec/cpu-all.h"
780 
781 #endif
782