target-xtensa/cpu.h

   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 CPU_XTENSA_H
  29 #define CPU_XTENSA_H
  30
  31 #define TARGET_LONG_BITS 32
  32 #define ELF_MACHINE EM_XTENSA
  33
  34 #define CPUState struct CPUXtensaState
  35
  36 #include "config.h"
  37 #include "qemu-common.h"
  38 #include "cpu-defs.h"
  39
  40 #define TARGET_HAS_ICE 1
  41
  42 #define NB_MMU_MODES 4
  43
  44 #define TARGET_PHYS_ADDR_SPACE_BITS 32
  45 #define TARGET_VIRT_ADDR_SPACE_BITS 32
  46 #define TARGET_PAGE_BITS 12
  47
  48 enum {
  49     /* Additional instructions */
  50     XTENSA_OPTION_CODE_DENSITY,
  51     XTENSA_OPTION_LOOP,
  52     XTENSA_OPTION_EXTENDED_L32R,
  53     XTENSA_OPTION_16_BIT_IMUL,
  54     XTENSA_OPTION_32_BIT_IMUL,
  55     XTENSA_OPTION_32_BIT_IMUL_HIGH,
  56     XTENSA_OPTION_32_BIT_IDIV,
  57     XTENSA_OPTION_MAC16,
  58     XTENSA_OPTION_MISC_OP_NSA,
  59     XTENSA_OPTION_MISC_OP_MINMAX,
  60     XTENSA_OPTION_MISC_OP_SEXT,
  61     XTENSA_OPTION_MISC_OP_CLAMPS,
  62     XTENSA_OPTION_COPROCESSOR,
  63     XTENSA_OPTION_BOOLEAN,
  64     XTENSA_OPTION_FP_COPROCESSOR,
  65     XTENSA_OPTION_MP_SYNCHRO,
  66     XTENSA_OPTION_CONDITIONAL_STORE,
  67
  68     /* Interrupts and exceptions */
  69     XTENSA_OPTION_EXCEPTION,
  70     XTENSA_OPTION_RELOCATABLE_VECTOR,
  71     XTENSA_OPTION_UNALIGNED_EXCEPTION,
  72     XTENSA_OPTION_INTERRUPT,
  73     XTENSA_OPTION_HIGH_PRIORITY_INTERRUPT,
  74     XTENSA_OPTION_TIMER_INTERRUPT,
  75
  76     /* Local memory */
  77     XTENSA_OPTION_ICACHE,
  78     XTENSA_OPTION_ICACHE_TEST,
  79     XTENSA_OPTION_ICACHE_INDEX_LOCK,
  80     XTENSA_OPTION_DCACHE,
  81     XTENSA_OPTION_DCACHE_TEST,
  82     XTENSA_OPTION_DCACHE_INDEX_LOCK,
  83     XTENSA_OPTION_IRAM,
  84     XTENSA_OPTION_IROM,
  85     XTENSA_OPTION_DRAM,
  86     XTENSA_OPTION_DROM,
  87     XTENSA_OPTION_XLMI,
  88     XTENSA_OPTION_HW_ALIGNMENT,
  89     XTENSA_OPTION_MEMORY_ECC_PARITY,
  90
  91     /* Memory protection and translation */
  92     XTENSA_OPTION_REGION_PROTECTION,
  93     XTENSA_OPTION_REGION_TRANSLATION,
  94     XTENSA_OPTION_MMU,
  95
  96     /* Other */
  97     XTENSA_OPTION_WINDOWED_REGISTER,
  98     XTENSA_OPTION_PROCESSOR_INTERFACE,
  99     XTENSA_OPTION_MISC_SR,
 100     XTENSA_OPTION_THREAD_POINTER,
 101     XTENSA_OPTION_PROCESSOR_ID,
 102     XTENSA_OPTION_DEBUG,
 103     XTENSA_OPTION_TRACE_PORT,
 104 };
 105
 106 enum {
 107     THREADPTR = 231,
 108     FCR = 232,
 109     FSR = 233,
 110 };
 111
 112 enum {
 113     LBEG = 0,
 114     LEND = 1,
 115     LCOUNT = 2,
 116     SAR = 3,
 117     BR = 4,
 118     LITBASE = 5,
 119     SCOMPARE1 = 12,
 120     ACCLO = 16,
 121     ACCHI = 17,
 122     MR = 32,
 123     WINDOW_BASE = 72,
 124     WINDOW_START = 73,
 125     PTEVADDR = 83,
 126     RASID = 90,
 127     ITLBCFG = 91,
 128     DTLBCFG = 92,
 129     EPC1 = 177,
 130     DEPC = 192,
 131     EPS2 = 194,
 132     EXCSAVE1 = 209,
 133     CPENABLE = 224,
 134     INTSET = 226,
 135     INTCLEAR = 227,
 136     INTENABLE = 228,
 137     PS = 230,
 138     VECBASE = 231,
 139     EXCCAUSE = 232,
 140     DEBUGCAUSE = 233,
 141     CCOUNT = 234,
 142     PRID = 235,
 143     EXCVADDR = 238,
 144     CCOMPARE = 240,
 145 };
 146
 147 #define PS_INTLEVEL 0xf
 148 #define PS_INTLEVEL_SHIFT 0
 149
 150 #define PS_EXCM 0x10
 151 #define PS_UM 0x20
 152
 153 #define PS_RING 0xc0
 154 #define PS_RING_SHIFT 6
 155
 156 #define PS_OWB 0xf00
 157 #define PS_OWB_SHIFT 8
 158
 159 #define PS_CALLINC 0x30000
 160 #define PS_CALLINC_SHIFT 16
 161 #define PS_CALLINC_LEN 2
 162
 163 #define PS_WOE 0x40000
 164
 165 #define DEBUGCAUSE_IC 0x1
 166 #define DEBUGCAUSE_IB 0x2
 167 #define DEBUGCAUSE_DB 0x4
 168 #define DEBUGCAUSE_BI 0x8
 169 #define DEBUGCAUSE_BN 0x10
 170 #define DEBUGCAUSE_DI 0x20
 171 #define DEBUGCAUSE_DBNUM 0xf00
 172 #define DEBUGCAUSE_DBNUM_SHIFT 8
 173
 174 #define MAX_NAREG 64
 175 #define MAX_NINTERRUPT 32
 176 #define MAX_NLEVEL 6
 177 #define MAX_NNMI 1
 178 #define MAX_NCCOMPARE 3
 179 #define MAX_TLB_WAY_SIZE 8
 180
 181 #define REGION_PAGE_MASK 0xe0000000
 182
 183 enum {
 184     /* Static vectors */
 185     EXC_RESET,
 186     EXC_MEMORY_ERROR,
 187
 188     /* Dynamic vectors */
 189     EXC_WINDOW_OVERFLOW4,
 190     EXC_WINDOW_UNDERFLOW4,
 191     EXC_WINDOW_OVERFLOW8,
 192     EXC_WINDOW_UNDERFLOW8,
 193     EXC_WINDOW_OVERFLOW12,
 194     EXC_WINDOW_UNDERFLOW12,
 195     EXC_IRQ,
 196     EXC_KERNEL,
 197     EXC_USER,
 198     EXC_DOUBLE,
 199     EXC_MAX
 200 };
 201
 202 enum {
 203     ILLEGAL_INSTRUCTION_CAUSE = 0,
 204     SYSCALL_CAUSE,
 205     INSTRUCTION_FETCH_ERROR_CAUSE,
 206     LOAD_STORE_ERROR_CAUSE,
 207     LEVEL1_INTERRUPT_CAUSE,
 208     ALLOCA_CAUSE,
 209     INTEGER_DIVIDE_BY_ZERO_CAUSE,
 210     PRIVILEGED_CAUSE = 8,
 211     LOAD_STORE_ALIGNMENT_CAUSE,
 212
 213     INSTR_PIF_DATA_ERROR_CAUSE = 12,
 214     LOAD_STORE_PIF_DATA_ERROR_CAUSE,
 215     INSTR_PIF_ADDR_ERROR_CAUSE,
 216     LOAD_STORE_PIF_ADDR_ERROR_CAUSE,
 217
 218     INST_TLB_MISS_CAUSE,
 219     INST_TLB_MULTI_HIT_CAUSE,
 220     INST_FETCH_PRIVILEGE_CAUSE,
 221     INST_FETCH_PROHIBITED_CAUSE = 20,
 222     LOAD_STORE_TLB_MISS_CAUSE = 24,
 223     LOAD_STORE_TLB_MULTI_HIT_CAUSE,
 224     LOAD_STORE_PRIVILEGE_CAUSE,
 225     LOAD_PROHIBITED_CAUSE = 28,
 226     STORE_PROHIBITED_CAUSE,
 227
 228     COPROCESSOR0_DISABLED = 32,
 229 };
 230
 231 typedef enum {
 232     INTTYPE_LEVEL,
 233     INTTYPE_EDGE,
 234     INTTYPE_NMI,
 235     INTTYPE_SOFTWARE,
 236     INTTYPE_TIMER,
 237     INTTYPE_DEBUG,
 238     INTTYPE_WRITE_ERR,
 239     INTTYPE_MAX
 240 } interrupt_type;
 241
 242 typedef struct xtensa_tlb_entry {
 243     uint32_t vaddr;
 244     uint32_t paddr;
 245     uint8_t asid;
 246     uint8_t attr;
 247     bool variable;
 248 } xtensa_tlb_entry;
 249
 250 typedef struct xtensa_tlb {
 251     unsigned nways;
 252     const unsigned way_size[10];
 253     bool varway56;
 254     unsigned nrefillentries;
 255 } xtensa_tlb;
 256
 257 typedef struct XtensaGdbReg {
 258     int targno;
 259     int type;
 260     int group;
 261 } XtensaGdbReg;
 262
 263 typedef struct XtensaGdbRegmap {
 264     int num_regs;
 265     int num_core_regs;
 266     /* PC + a + ar + sr + ur */
 267     XtensaGdbReg reg[1 + 16 + 64 + 256 + 256];
 268 } XtensaGdbRegmap;
 269
 270 typedef struct XtensaConfig {
 271     const char *name;
 272     uint64_t options;
 273     XtensaGdbRegmap gdb_regmap;
 274     unsigned nareg;
 275     int excm_level;
 276     int ndepc;
 277     uint32_t vecbase;
 278     uint32_t exception_vector[EXC_MAX];
 279     unsigned ninterrupt;
 280     unsigned nlevel;
 281     uint32_t interrupt_vector[MAX_NLEVEL + MAX_NNMI + 1];
 282     uint32_t level_mask[MAX_NLEVEL + MAX_NNMI + 1];
 283     uint32_t inttype_mask[INTTYPE_MAX];
 284     struct {
 285         uint32_t level;
 286         interrupt_type inttype;
 287     } interrupt[MAX_NINTERRUPT];
 288     unsigned nccompare;
 289     uint32_t timerint[MAX_NCCOMPARE];
 290     unsigned nextint;
 291     unsigned extint[MAX_NINTERRUPT];
 292
 293     unsigned debug_level;
 294     unsigned nibreak;
 295     unsigned ndbreak;
 296
 297     uint32_t clock_freq_khz;
 298
 299     xtensa_tlb itlb;
 300     xtensa_tlb dtlb;
 301 } XtensaConfig;
 302
 303 typedef struct XtensaConfigList {
 304     const XtensaConfig *config;
 305     struct XtensaConfigList *next;
 306 } XtensaConfigList;
 307
 308 typedef struct CPUXtensaState {
 309     const XtensaConfig *config;
 310     uint32_t regs[16];
 311     uint32_t pc;
 312     uint32_t sregs[256];
 313     uint32_t uregs[256];
 314     uint32_t phys_regs[MAX_NAREG];
 315
 316     xtensa_tlb_entry itlb[7][MAX_TLB_WAY_SIZE];
 317     xtensa_tlb_entry dtlb[10][MAX_TLB_WAY_SIZE];
 318     unsigned autorefill_idx;
 319
 320     int pending_irq_level; /* level of last raised IRQ */
 321     void **irq_inputs;
 322     QEMUTimer *ccompare_timer;
 323     uint32_t wake_ccount;
 324     int64_t halt_clock;
 325
 326     int exception_taken;
 327
 328     CPU_COMMON
 329 } CPUXtensaState;
 330
 331 #define cpu_init cpu_xtensa_init
 332 #define cpu_exec cpu_xtensa_exec
 333 #define cpu_gen_code cpu_xtensa_gen_code
 334 #define cpu_signal_handler cpu_xtensa_signal_handler
 335 #define cpu_list xtensa_cpu_list
 336
 337 CPUXtensaState *cpu_xtensa_init(const char *cpu_model);
 338 void xtensa_translate_init(void);
 339 int cpu_xtensa_exec(CPUXtensaState *s);
 340 void xtensa_register_core(XtensaConfigList *node);
 341 void do_interrupt(CPUXtensaState *s);
 342 void check_interrupts(CPUXtensaState *s);
 343 void xtensa_irq_init(CPUState *env);
 344 void *xtensa_get_extint(CPUState *env, unsigned extint);
 345 void xtensa_advance_ccount(CPUState *env, uint32_t d);
 346 void xtensa_timer_irq(CPUState *env, uint32_t id, uint32_t active);
 347 void xtensa_rearm_ccompare_timer(CPUState *env);
 348 int cpu_xtensa_signal_handler(int host_signum, void *pinfo, void *puc);
 349 void xtensa_cpu_list(FILE *f, fprintf_function cpu_fprintf);
 350 void xtensa_sync_window_from_phys(CPUState *env);
 351 void xtensa_sync_phys_from_window(CPUState *env);
 352 uint32_t xtensa_tlb_get_addr_mask(const CPUState *env, bool dtlb, uint32_t way);
 353 void split_tlb_entry_spec_way(const CPUState *env, uint32_t v, bool dtlb,
 354         uint32_t *vpn, uint32_t wi, uint32_t *ei);
 355 int xtensa_tlb_lookup(const CPUState *env, uint32_t addr, bool dtlb,
 356         uint32_t *pwi, uint32_t *pei, uint8_t *pring);
 357 void xtensa_tlb_set_entry(CPUState *env, bool dtlb,
 358         unsigned wi, unsigned ei, uint32_t vpn, uint32_t pte);
 359 int xtensa_get_physical_addr(CPUState *env,
 360         uint32_t vaddr, int is_write, int mmu_idx,
 361         uint32_t *paddr, uint32_t *page_size, unsigned *access);
 362 void dump_mmu(FILE *f, fprintf_function cpu_fprintf, CPUState *env);
 363
 364
 365 #define XTENSA_OPTION_BIT(opt) (((uint64_t)1) << (opt))
 366
 367 static inline bool xtensa_option_bits_enabled(const XtensaConfig *config,
 368         uint64_t opt)
 369 {
 370     return (config->options & opt) != 0;
 371 }
 372
 373 static inline bool xtensa_option_enabled(const XtensaConfig *config, int opt)
 374 {
 375     return xtensa_option_bits_enabled(config, XTENSA_OPTION_BIT(opt));
 376 }
 377
 378 static inline int xtensa_get_cintlevel(const CPUState *env)
 379 {
 380     int level = (env->sregs[PS] & PS_INTLEVEL) >> PS_INTLEVEL_SHIFT;
 381     if ((env->sregs[PS] & PS_EXCM) && env->config->excm_level > level) {
 382         level = env->config->excm_level;
 383     }
 384     return level;
 385 }
 386
 387 static inline int xtensa_get_ring(const CPUState *env)
 388 {
 389     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU)) {
 390         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
 391     } else {
 392         return 0;
 393     }
 394 }
 395
 396 static inline int xtensa_get_cring(const CPUState *env)
 397 {
 398     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU) &&
 399             (env->sregs[PS] & PS_EXCM) == 0) {
 400         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
 401     } else {
 402         return 0;
 403     }
 404 }
 405
 406 static inline xtensa_tlb_entry *xtensa_tlb_get_entry(CPUState *env,
 407         bool dtlb, unsigned wi, unsigned ei)
 408 {
 409     return dtlb ?
 410         env->dtlb[wi] + ei :
 411         env->itlb[wi] + ei;
 412 }
 413
 414 /* MMU modes definitions */
 415 #define MMU_MODE0_SUFFIX _ring0
 416 #define MMU_MODE1_SUFFIX _ring1
 417 #define MMU_MODE2_SUFFIX _ring2
 418 #define MMU_MODE3_SUFFIX _ring3
 419
 420 static inline int cpu_mmu_index(CPUState *env)
 421 {
 422     return xtensa_get_cring(env);
 423 }
 424
 425 #define XTENSA_TBFLAG_RING_MASK 0x3
 426 #define XTENSA_TBFLAG_EXCM 0x4
 427 #define XTENSA_TBFLAG_LITBASE 0x8
 428
 429 static inline void cpu_get_tb_cpu_state(CPUState *env, target_ulong *pc,
 430         target_ulong *cs_base, int *flags)
 431 {
 432     *pc = env->pc;
 433     *cs_base = 0;
 434     *flags = 0;
 435     *flags |= xtensa_get_ring(env);
 436     if (env->sregs[PS] & PS_EXCM) {
 437         *flags |= XTENSA_TBFLAG_EXCM;
 438     }
 439     if (xtensa_option_enabled(env->config, XTENSA_OPTION_EXTENDED_L32R) &&
 440             (env->sregs[LITBASE] & 1)) {
 441         *flags |= XTENSA_TBFLAG_LITBASE;
 442     }
 443 }
 444
 445 #include "cpu-all.h"
 446 #include "exec-all.h"
 447
 448 static inline int cpu_has_work(CPUState *env)
 449 {
 450     return env->pending_irq_level;
 451 }
 452
 453 static inline void cpu_pc_from_tb(CPUState *env, TranslationBlock *tb)
 454 {
 455     env->pc = tb->pc;
 456 }
 457
 458 #endif