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 ALIGNED_ONLY
  32 #define TARGET_LONG_BITS 32
  33 #define ELF_MACHINE EM_XTENSA
  34
  35 #define CPUArchState struct CPUXtensaState
  36
  37 #include "config.h"
  38 #include "qemu-common.h"
  39 #include "exec/cpu-defs.h"
  40 #include "fpu/softfloat.h"
  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     XTENSA_OPTION_ATOMCTL,
  68
  69     /* Interrupts and exceptions */
  70     XTENSA_OPTION_EXCEPTION,
  71     XTENSA_OPTION_RELOCATABLE_VECTOR,
  72     XTENSA_OPTION_UNALIGNED_EXCEPTION,
  73     XTENSA_OPTION_INTERRUPT,
  74     XTENSA_OPTION_HIGH_PRIORITY_INTERRUPT,
  75     XTENSA_OPTION_TIMER_INTERRUPT,
  76
  77     /* Local memory */
  78     XTENSA_OPTION_ICACHE,
  79     XTENSA_OPTION_ICACHE_TEST,
  80     XTENSA_OPTION_ICACHE_INDEX_LOCK,
  81     XTENSA_OPTION_DCACHE,
  82     XTENSA_OPTION_DCACHE_TEST,
  83     XTENSA_OPTION_DCACHE_INDEX_LOCK,
  84     XTENSA_OPTION_IRAM,
  85     XTENSA_OPTION_IROM,
  86     XTENSA_OPTION_DRAM,
  87     XTENSA_OPTION_DROM,
  88     XTENSA_OPTION_XLMI,
  89     XTENSA_OPTION_HW_ALIGNMENT,
  90     XTENSA_OPTION_MEMORY_ECC_PARITY,
  91
  92     /* Memory protection and translation */
  93     XTENSA_OPTION_REGION_PROTECTION,
  94     XTENSA_OPTION_REGION_TRANSLATION,
  95     XTENSA_OPTION_MMU,
  96     XTENSA_OPTION_CACHEATTR,
  97
  98     /* Other */
  99     XTENSA_OPTION_WINDOWED_REGISTER,
 100     XTENSA_OPTION_PROCESSOR_INTERFACE,
 101     XTENSA_OPTION_MISC_SR,
 102     XTENSA_OPTION_THREAD_POINTER,
 103     XTENSA_OPTION_PROCESSOR_ID,
 104     XTENSA_OPTION_DEBUG,
 105     XTENSA_OPTION_TRACE_PORT,
 106 };
 107
 108 enum {
 109     THREADPTR = 231,
 110     FCR = 232,
 111     FSR = 233,
 112 };
 113
 114 enum {
 115     LBEG = 0,
 116     LEND = 1,
 117     LCOUNT = 2,
 118     SAR = 3,
 119     BR = 4,
 120     LITBASE = 5,
 121     SCOMPARE1 = 12,
 122     ACCLO = 16,
 123     ACCHI = 17,
 124     MR = 32,
 125     WINDOW_BASE = 72,
 126     WINDOW_START = 73,
 127     PTEVADDR = 83,
 128     RASID = 90,
 129     ITLBCFG = 91,
 130     DTLBCFG = 92,
 131     IBREAKENABLE = 96,
 132     CACHEATTR = 98,
 133     ATOMCTL = 99,
 134     IBREAKA = 128,
 135     DBREAKA = 144,
 136     DBREAKC = 160,
 137     CONFIGID0 = 176,
 138     EPC1 = 177,
 139     DEPC = 192,
 140     EPS2 = 194,
 141     CONFIGID1 = 208,
 142     EXCSAVE1 = 209,
 143     CPENABLE = 224,
 144     INTSET = 226,
 145     INTCLEAR = 227,
 146     INTENABLE = 228,
 147     PS = 230,
 148     VECBASE = 231,
 149     EXCCAUSE = 232,
 150     DEBUGCAUSE = 233,
 151     CCOUNT = 234,
 152     PRID = 235,
 153     ICOUNT = 236,
 154     ICOUNTLEVEL = 237,
 155     EXCVADDR = 238,
 156     CCOMPARE = 240,
 157     MISC = 244,
 158 };
 159
 160 #define PS_INTLEVEL 0xf
 161 #define PS_INTLEVEL_SHIFT 0
 162
 163 #define PS_EXCM 0x10
 164 #define PS_UM 0x20
 165
 166 #define PS_RING 0xc0
 167 #define PS_RING_SHIFT 6
 168
 169 #define PS_OWB 0xf00
 170 #define PS_OWB_SHIFT 8
 171
 172 #define PS_CALLINC 0x30000
 173 #define PS_CALLINC_SHIFT 16
 174 #define PS_CALLINC_LEN 2
 175
 176 #define PS_WOE 0x40000
 177
 178 #define DEBUGCAUSE_IC 0x1
 179 #define DEBUGCAUSE_IB 0x2
 180 #define DEBUGCAUSE_DB 0x4
 181 #define DEBUGCAUSE_BI 0x8
 182 #define DEBUGCAUSE_BN 0x10
 183 #define DEBUGCAUSE_DI 0x20
 184 #define DEBUGCAUSE_DBNUM 0xf00
 185 #define DEBUGCAUSE_DBNUM_SHIFT 8
 186
 187 #define DBREAKC_SB 0x80000000
 188 #define DBREAKC_LB 0x40000000
 189 #define DBREAKC_SB_LB (DBREAKC_SB | DBREAKC_LB)
 190 #define DBREAKC_MASK 0x3f
 191
 192 #define MAX_NAREG 64
 193 #define MAX_NINTERRUPT 32
 194 #define MAX_NLEVEL 6
 195 #define MAX_NNMI 1
 196 #define MAX_NCCOMPARE 3
 197 #define MAX_TLB_WAY_SIZE 8
 198 #define MAX_NDBREAK 2
 199
 200 #define REGION_PAGE_MASK 0xe0000000
 201
 202 #define PAGE_CACHE_MASK    0x700
 203 #define PAGE_CACHE_SHIFT   8
 204 #define PAGE_CACHE_INVALID 0x000
 205 #define PAGE_CACHE_BYPASS  0x100
 206 #define PAGE_CACHE_WT      0x200
 207 #define PAGE_CACHE_WB      0x400
 208 #define PAGE_CACHE_ISOLATE 0x600
 209
 210 enum {
 211     /* Static vectors */
 212     EXC_RESET,
 213     EXC_MEMORY_ERROR,
 214
 215     /* Dynamic vectors */
 216     EXC_WINDOW_OVERFLOW4,
 217     EXC_WINDOW_UNDERFLOW4,
 218     EXC_WINDOW_OVERFLOW8,
 219     EXC_WINDOW_UNDERFLOW8,
 220     EXC_WINDOW_OVERFLOW12,
 221     EXC_WINDOW_UNDERFLOW12,
 222     EXC_IRQ,
 223     EXC_KERNEL,
 224     EXC_USER,
 225     EXC_DOUBLE,
 226     EXC_DEBUG,
 227     EXC_MAX
 228 };
 229
 230 enum {
 231     ILLEGAL_INSTRUCTION_CAUSE = 0,
 232     SYSCALL_CAUSE,
 233     INSTRUCTION_FETCH_ERROR_CAUSE,
 234     LOAD_STORE_ERROR_CAUSE,
 235     LEVEL1_INTERRUPT_CAUSE,
 236     ALLOCA_CAUSE,
 237     INTEGER_DIVIDE_BY_ZERO_CAUSE,
 238     PRIVILEGED_CAUSE = 8,
 239     LOAD_STORE_ALIGNMENT_CAUSE,
 240
 241     INSTR_PIF_DATA_ERROR_CAUSE = 12,
 242     LOAD_STORE_PIF_DATA_ERROR_CAUSE,
 243     INSTR_PIF_ADDR_ERROR_CAUSE,
 244     LOAD_STORE_PIF_ADDR_ERROR_CAUSE,
 245
 246     INST_TLB_MISS_CAUSE,
 247     INST_TLB_MULTI_HIT_CAUSE,
 248     INST_FETCH_PRIVILEGE_CAUSE,
 249     INST_FETCH_PROHIBITED_CAUSE = 20,
 250     LOAD_STORE_TLB_MISS_CAUSE = 24,
 251     LOAD_STORE_TLB_MULTI_HIT_CAUSE,
 252     LOAD_STORE_PRIVILEGE_CAUSE,
 253     LOAD_PROHIBITED_CAUSE = 28,
 254     STORE_PROHIBITED_CAUSE,
 255
 256     COPROCESSOR0_DISABLED = 32,
 257 };
 258
 259 typedef enum {
 260     INTTYPE_LEVEL,
 261     INTTYPE_EDGE,
 262     INTTYPE_NMI,
 263     INTTYPE_SOFTWARE,
 264     INTTYPE_TIMER,
 265     INTTYPE_DEBUG,
 266     INTTYPE_WRITE_ERR,
 267     INTTYPE_PROFILING,
 268     INTTYPE_MAX
 269 } interrupt_type;
 270
 271 typedef struct xtensa_tlb_entry {
 272     uint32_t vaddr;
 273     uint32_t paddr;
 274     uint8_t asid;
 275     uint8_t attr;
 276     bool variable;
 277 } xtensa_tlb_entry;
 278
 279 typedef struct xtensa_tlb {
 280     unsigned nways;
 281     const unsigned way_size[10];
 282     bool varway56;
 283     unsigned nrefillentries;
 284 } xtensa_tlb;
 285
 286 typedef struct XtensaGdbReg {
 287     int targno;
 288     int type;
 289     int group;
 290 } XtensaGdbReg;
 291
 292 typedef struct XtensaGdbRegmap {
 293     int num_regs;
 294     int num_core_regs;
 295     /* PC + a + ar + sr + ur */
 296     XtensaGdbReg reg[1 + 16 + 64 + 256 + 256];
 297 } XtensaGdbRegmap;
 298
 299 typedef struct XtensaConfig {
 300     const char *name;
 301     uint64_t options;
 302     XtensaGdbRegmap gdb_regmap;
 303     unsigned nareg;
 304     int excm_level;
 305     int ndepc;
 306     uint32_t vecbase;
 307     uint32_t exception_vector[EXC_MAX];
 308     unsigned ninterrupt;
 309     unsigned nlevel;
 310     uint32_t interrupt_vector[MAX_NLEVEL + MAX_NNMI + 1];
 311     uint32_t level_mask[MAX_NLEVEL + MAX_NNMI + 1];
 312     uint32_t inttype_mask[INTTYPE_MAX];
 313     struct {
 314         uint32_t level;
 315         interrupt_type inttype;
 316     } interrupt[MAX_NINTERRUPT];
 317     unsigned nccompare;
 318     uint32_t timerint[MAX_NCCOMPARE];
 319     unsigned nextint;
 320     unsigned extint[MAX_NINTERRUPT];
 321
 322     unsigned debug_level;
 323     unsigned nibreak;
 324     unsigned ndbreak;
 325
 326     uint32_t configid[2];
 327
 328     uint32_t clock_freq_khz;
 329
 330     xtensa_tlb itlb;
 331     xtensa_tlb dtlb;
 332 } XtensaConfig;
 333
 334 typedef struct XtensaConfigList {
 335     const XtensaConfig *config;
 336     struct XtensaConfigList *next;
 337 } XtensaConfigList;
 338
 339 typedef struct CPUXtensaState {
 340     const XtensaConfig *config;
 341     uint32_t regs[16];
 342     uint32_t pc;
 343     uint32_t sregs[256];
 344     uint32_t uregs[256];
 345     uint32_t phys_regs[MAX_NAREG];
 346     float32 fregs[16];
 347     float_status fp_status;
 348
 349     xtensa_tlb_entry itlb[7][MAX_TLB_WAY_SIZE];
 350     xtensa_tlb_entry dtlb[10][MAX_TLB_WAY_SIZE];
 351     unsigned autorefill_idx;
 352
 353     int pending_irq_level; /* level of last raised IRQ */
 354     void **irq_inputs;
 355     QEMUTimer *ccompare_timer;
 356     uint32_t wake_ccount;
 357     int64_t halt_clock;
 358
 359     int exception_taken;
 360
 361     /* Watchpoints for DBREAK registers */
 362     struct CPUWatchpoint *cpu_watchpoint[MAX_NDBREAK];
 363
 364     CPU_COMMON
 365 } CPUXtensaState;
 366
 367 #include "cpu-qom.h"
 368
 369 #define cpu_exec cpu_xtensa_exec
 370 #define cpu_gen_code cpu_xtensa_gen_code
 371 #define cpu_signal_handler cpu_xtensa_signal_handler
 372 #define cpu_list xtensa_cpu_list
 373
 374 #ifdef TARGET_WORDS_BIGENDIAN
 375 #define XTENSA_DEFAULT_CPU_MODEL "fsf"
 376 #else
 377 #define XTENSA_DEFAULT_CPU_MODEL "dc232b"
 378 #endif
 379
 380 XtensaCPU *cpu_xtensa_init(const char *cpu_model);
 381
 382 #define cpu_init(cpu_model) CPU(cpu_xtensa_init(cpu_model))
 383
 384 void xtensa_translate_init(void);
 385 void xtensa_breakpoint_handler(CPUState *cs);
 386 int cpu_xtensa_exec(CPUXtensaState *s);
 387 void xtensa_register_core(XtensaConfigList *node);
 388 void check_interrupts(CPUXtensaState *s);
 389 void xtensa_irq_init(CPUXtensaState *env);
 390 void *xtensa_get_extint(CPUXtensaState *env, unsigned extint);
 391 void xtensa_advance_ccount(CPUXtensaState *env, uint32_t d);
 392 void xtensa_timer_irq(CPUXtensaState *env, uint32_t id, uint32_t active);
 393 void xtensa_rearm_ccompare_timer(CPUXtensaState *env);
 394 int cpu_xtensa_signal_handler(int host_signum, void *pinfo, void *puc);
 395 void xtensa_cpu_list(FILE *f, fprintf_function cpu_fprintf);
 396 void xtensa_sync_window_from_phys(CPUXtensaState *env);
 397 void xtensa_sync_phys_from_window(CPUXtensaState *env);
 398 uint32_t xtensa_tlb_get_addr_mask(const CPUXtensaState *env, bool dtlb, uint32_t way);
 399 void split_tlb_entry_spec_way(const CPUXtensaState *env, uint32_t v, bool dtlb,
 400         uint32_t *vpn, uint32_t wi, uint32_t *ei);
 401 int xtensa_tlb_lookup(const CPUXtensaState *env, uint32_t addr, bool dtlb,
 402         uint32_t *pwi, uint32_t *pei, uint8_t *pring);
 403 void xtensa_tlb_set_entry_mmu(const CPUXtensaState *env,
 404         xtensa_tlb_entry *entry, bool dtlb,
 405         unsigned wi, unsigned ei, uint32_t vpn, uint32_t pte);
 406 void xtensa_tlb_set_entry(CPUXtensaState *env, bool dtlb,
 407         unsigned wi, unsigned ei, uint32_t vpn, uint32_t pte);
 408 int xtensa_get_physical_addr(CPUXtensaState *env, bool update_tlb,
 409         uint32_t vaddr, int is_write, int mmu_idx,
 410         uint32_t *paddr, uint32_t *page_size, unsigned *access);
 411 void reset_mmu(CPUXtensaState *env);
 412 void dump_mmu(FILE *f, fprintf_function cpu_fprintf, CPUXtensaState *env);
 413 void debug_exception_env(CPUXtensaState *new_env, uint32_t cause);
 414
 415
 416 #define XTENSA_OPTION_BIT(opt) (((uint64_t)1) << (opt))
 417 #define XTENSA_OPTION_ALL (~(uint64_t)0)
 418
 419 static inline bool xtensa_option_bits_enabled(const XtensaConfig *config,
 420         uint64_t opt)
 421 {
 422     return (config->options & opt) != 0;
 423 }
 424
 425 static inline bool xtensa_option_enabled(const XtensaConfig *config, int opt)
 426 {
 427     return xtensa_option_bits_enabled(config, XTENSA_OPTION_BIT(opt));
 428 }
 429
 430 static inline int xtensa_get_cintlevel(const CPUXtensaState *env)
 431 {
 432     int level = (env->sregs[PS] & PS_INTLEVEL) >> PS_INTLEVEL_SHIFT;
 433     if ((env->sregs[PS] & PS_EXCM) && env->config->excm_level > level) {
 434         level = env->config->excm_level;
 435     }
 436     return level;
 437 }
 438
 439 static inline int xtensa_get_ring(const CPUXtensaState *env)
 440 {
 441     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU)) {
 442         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
 443     } else {
 444         return 0;
 445     }
 446 }
 447
 448 static inline int xtensa_get_cring(const CPUXtensaState *env)
 449 {
 450     if (xtensa_option_enabled(env->config, XTENSA_OPTION_MMU) &&
 451             (env->sregs[PS] & PS_EXCM) == 0) {
 452         return (env->sregs[PS] & PS_RING) >> PS_RING_SHIFT;
 453     } else {
 454         return 0;
 455     }
 456 }
 457
 458 static inline xtensa_tlb_entry *xtensa_tlb_get_entry(CPUXtensaState *env,
 459         bool dtlb, unsigned wi, unsigned ei)
 460 {
 461     return dtlb ?
 462         env->dtlb[wi] + ei :
 463         env->itlb[wi] + ei;
 464 }
 465
 466 static inline uint32_t xtensa_replicate_windowstart(CPUXtensaState *env)
 467 {
 468     return env->sregs[WINDOW_START] |
 469         (env->sregs[WINDOW_START] << env->config->nareg / 4);
 470 }
 471
 472 /* MMU modes definitions */
 473 #define MMU_MODE0_SUFFIX _ring0
 474 #define MMU_MODE1_SUFFIX _ring1
 475 #define MMU_MODE2_SUFFIX _ring2
 476 #define MMU_MODE3_SUFFIX _ring3
 477
 478 static inline int cpu_mmu_index(CPUXtensaState *env)
 479 {
 480     return xtensa_get_cring(env);
 481 }
 482
 483 #define XTENSA_TBFLAG_RING_MASK 0x3
 484 #define XTENSA_TBFLAG_EXCM 0x4
 485 #define XTENSA_TBFLAG_LITBASE 0x8
 486 #define XTENSA_TBFLAG_DEBUG 0x10
 487 #define XTENSA_TBFLAG_ICOUNT 0x20
 488 #define XTENSA_TBFLAG_CPENABLE_MASK 0x3fc0
 489 #define XTENSA_TBFLAG_CPENABLE_SHIFT 6
 490 #define XTENSA_TBFLAG_EXCEPTION 0x4000
 491 #define XTENSA_TBFLAG_WINDOW_MASK 0x18000
 492 #define XTENSA_TBFLAG_WINDOW_SHIFT 15
 493
 494 static inline void cpu_get_tb_cpu_state(CPUXtensaState *env, target_ulong *pc,
 495         target_ulong *cs_base, int *flags)
 496 {
 497     CPUState *cs = CPU(xtensa_env_get_cpu(env));
 498
 499     *pc = env->pc;
 500     *cs_base = 0;
 501     *flags = 0;
 502     *flags |= xtensa_get_ring(env);
 503     if (env->sregs[PS] & PS_EXCM) {
 504         *flags |= XTENSA_TBFLAG_EXCM;
 505     }
 506     if (xtensa_option_enabled(env->config, XTENSA_OPTION_EXTENDED_L32R) &&
 507             (env->sregs[LITBASE] & 1)) {
 508         *flags |= XTENSA_TBFLAG_LITBASE;
 509     }
 510     if (xtensa_option_enabled(env->config, XTENSA_OPTION_DEBUG)) {
 511         if (xtensa_get_cintlevel(env) < env->config->debug_level) {
 512             *flags |= XTENSA_TBFLAG_DEBUG;
 513         }
 514         if (xtensa_get_cintlevel(env) < env->sregs[ICOUNTLEVEL]) {
 515             *flags |= XTENSA_TBFLAG_ICOUNT;
 516         }
 517     }
 518     if (xtensa_option_enabled(env->config, XTENSA_OPTION_COPROCESSOR)) {
 519         *flags |= env->sregs[CPENABLE] << XTENSA_TBFLAG_CPENABLE_SHIFT;
 520     }
 521     if (cs->singlestep_enabled && env->exception_taken) {
 522         *flags |= XTENSA_TBFLAG_EXCEPTION;
 523     }
 524     if (xtensa_option_enabled(env->config, XTENSA_OPTION_WINDOWED_REGISTER) &&
 525         (env->sregs[PS] & (PS_WOE | PS_EXCM)) == PS_WOE) {
 526         uint32_t windowstart = xtensa_replicate_windowstart(env) >>
 527             (env->sregs[WINDOW_BASE] + 1);
 528         uint32_t w = ctz32(windowstart | 0x8);
 529
 530         *flags |= w << XTENSA_TBFLAG_WINDOW_SHIFT;
 531     } else {
 532         *flags |= 3 << XTENSA_TBFLAG_WINDOW_SHIFT;
 533     }
 534 }
 535
 536 #include "exec/cpu-all.h"
 537 #include "exec/exec-all.h"
 538
 539 #endif