src/include/cpu_mips.h

#ifndef CPU_MIPS_H
#define CPU_MIPS_H

/*
 *  Copyright (C) 2003-2007  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: cpu_mips.h,v 1.55 2007/02/07 18:58:32 debug Exp $
 */

#include "interrupt.h"
#include "misc.h"

struct cpu_family;
struct emul;
struct machine;
struct timer;

/*
 *  CPU type definitions:  See mips_cpu_types.h.
 */

struct mips_cpu_type_def {
        char            *name;
        int             rev;
        int             sub;
        char            flags;
        char            exc_model;              /*  EXC3K or EXC4K  */
        char            mmu_model;              /*  MMU3K or MMU4K  */
        char            isa_level;              /*  1, 2, 3, 4, 5, 32, 64  */
        char            isa_revision;           /*  1 or 2 (for MIPS32/64)  */
        int             nr_of_tlb_entries;      /*  32, 48, 64, ...  */
        char            instrs_per_cycle;       /*  simplified, 1, 2, or 4  */
        int             picache;
        int             pilinesize;
        int             piways;
        int             pdcache;
        int             pdlinesize;
        int             pdways;
        int             scache;
        int             slinesize;
        int             sways;
};

#define INITIAL_PC                      0xffffffffbfc00000ULL
#define INITIAL_STACK_POINTER           (0xffffffffa0008000ULL - 256)


/*
 *  Coproc 0:
 *
 *  NOTE:
 *      On R3000, only hi and lo0 are used, and then only the lowest 32 bits.
 */
#define N_MIPS_COPROC_REGS      32
struct mips_tlb {
        uint64_t        hi;
        uint64_t        lo0;
        uint64_t        lo1;
        uint64_t        mask;
};


/*
 *  Coproc 1:
 */
/*  FPU control registers:  */
#define N_MIPS_FCRS                     32
#define MIPS_FPU_FCIR                   0
#define MIPS_FPU_FCCR                   25
#define MIPS_FPU_FCSR                   31
#define    MIPS_FCSR_FCC0_SHIFT            23
#define    MIPS_FCSR_FCC1_SHIFT            25

#define N_VADDR_TO_TLB_INDEX_ENTRIES    (1 << 20)

struct mips_coproc {
        int             coproc_nr;
        uint64_t        reg[N_MIPS_COPROC_REGS];

        /*  Only for COP0:  */
        struct mips_tlb *tlbs;
        int             nr_of_tlbs;

        /*  Only for COP1:  floating point control registers  */
        /*  (Maybe also for COP0?)  */
        uint64_t        fcr[N_MIPS_FCRS];
};

#define N_MIPS_COPROCS          4

#define N_MIPS_GPRS             32      /*  General purpose registers  */
#define N_MIPS_FPRS             32      /*  Floating point registers  */

/*
 *  These should all be 2 characters wide:
 *
 *  NOTE: These are for 32-bit ABIs. For the 64-bit ABI, registers 8..11
 *  are used to pass arguments and are then called "a4".."a7".
 *
 *  TODO: Should there be two different variants of this? It's not really
 *  possible to figure out in some easy way if the code running was
 *  written for a 32-bit or 64-bit ABI.
 */
#define MIPS_REGISTER_NAMES     { \
        "zr", "at", "v0", "v1", "a0", "a1", "a2", "a3", \
        "t0", "t1", "t2", "t3", "t4", "t5", "t6", "t7", \
        "s0", "s1", "s2", "s3", "s4", "s5", "s6", "s7", \
        "t8", "t9", "k0", "k1", "gp", "sp", "fp", "ra"  }

#define MIPS_GPR_ZERO           0               /*  zero  */
#define MIPS_GPR_AT             1               /*  at  */
#define MIPS_GPR_V0             2               /*  v0  */
#define MIPS_GPR_V1             3               /*  v1  */
#define MIPS_GPR_A0             4               /*  a0  */
#define MIPS_GPR_A1             5               /*  a1  */
#define MIPS_GPR_A2             6               /*  a2  */
#define MIPS_GPR_A3             7               /*  a3  */
#define MIPS_GPR_T0             8               /*  t0  */
#define MIPS_GPR_T1             9               /*  t1  */
#define MIPS_GPR_T2             10              /*  t2  */
#define MIPS_GPR_T3             11              /*  t3  */
#define MIPS_GPR_T4             12              /*  t4  */
#define MIPS_GPR_T5             13              /*  t5  */
#define MIPS_GPR_T6             14              /*  t6  */
#define MIPS_GPR_T7             15              /*  t7  */
#define MIPS_GPR_S0             16              /*  s0  */
#define MIPS_GPR_S1             17              /*  s1  */
#define MIPS_GPR_S2             18              /*  s2  */
#define MIPS_GPR_S3             19              /*  s3  */
#define MIPS_GPR_S4             20              /*  s4  */
#define MIPS_GPR_S5             21              /*  s5  */
#define MIPS_GPR_S6             22              /*  s6  */
#define MIPS_GPR_S7             23              /*  s7  */
#define MIPS_GPR_T8             24              /*  t8  */
#define MIPS_GPR_T9             25              /*  t9  */
#define MIPS_GPR_K0             26              /*  k0  */
#define MIPS_GPR_K1             27              /*  k1  */
#define MIPS_GPR_GP             28              /*  gp  */
#define MIPS_GPR_SP             29              /*  sp  */
#define MIPS_GPR_FP             30              /*  fp  */
#define MIPS_GPR_RA             31              /*  ra  */

#define N_HI6                   64
#define N_SPECIAL               64
#define N_REGIMM                32


/*  An "impossible" paddr:  */
#define IMPOSSIBLE_PADDR                0x1212343456566767ULL

#define DEFAULT_PCACHE_SIZE             15      /*  32 KB  */
#define DEFAULT_PCACHE_LINESIZE         5       /*  32 bytes  */

struct r3000_cache_line {
        uint32_t        tag_paddr;
        int             tag_valid;
};
#define R3000_TAG_VALID         1
#define R3000_TAG_DIRTY         2

struct r4000_cache_line {
        char            dummy;
};


#ifdef ONEKPAGE
#define MIPS_IC_ENTRIES_SHIFT           8
#else
#define MIPS_IC_ENTRIES_SHIFT           10
#endif

#define MIPS_N_IC_ARGS                  3
#define MIPS_INSTR_ALIGNMENT_SHIFT      2
#define MIPS_IC_ENTRIES_PER_PAGE        (1 << MIPS_IC_ENTRIES_SHIFT)
#define MIPS_PC_TO_IC_ENTRY(a)          (((a)>>MIPS_INSTR_ALIGNMENT_SHIFT) \
                                        & (MIPS_IC_ENTRIES_PER_PAGE-1))
#define MIPS_ADDR_TO_PAGENR(a)          ((a) >> (MIPS_IC_ENTRIES_SHIFT \
                                        + MIPS_INSTR_ALIGNMENT_SHIFT))

#define MIPS_L2N                17
#define MIPS_L3N                18

#define MIPS_MAX_VPH_TLB_ENTRIES        128
DYNTRANS_MISC_DECLARATIONS(mips,MIPS,uint64_t)
DYNTRANS_MISC64_DECLARATIONS(mips,MIPS,uint8_t)


struct mips_cpu {
        struct mips_cpu_type_def cpu_type;

        /*  General purpose registers:  */
        uint64_t        gpr[N_MIPS_GPRS];

        /*  Dummy destination register when writing to the zero register:  */
        uint64_t        scratch;

        /*  Special purpose registers:  */
        uint64_t        hi;
        uint64_t        lo;

        /*  Coprocessors:  */
        struct mips_coproc *coproc[N_MIPS_COPROCS];
        uint64_t        cop0_config_select1;

        int             last_written_tlb_index;

        /*  Count/compare timer:  */
        int             compare_register_set;
        int             compare_interrupts_pending;
        struct interrupt irq_compare;
        struct timer    *timer;

        int             rmw;            /*  Read-Modify-Write  */
        int             rmw_len;        /*  Length of rmw modification  */
        uint64_t        rmw_addr;       /*  Address of rmw modification  */

        /*
         *  NOTE:  The R5900 has 128-bit registers. I'm not really sure
         *  whether they are used a lot or not, at least with code produced
         *  with gcc they are not. An important case however is lq and sq
         *  (load and store of 128-bit values). These "upper halves" of R5900
         *  quadwords can be used in those cases.
         *
         *  hi1 and lo1 are the high 64-bit parts of the hi and lo registers.
         *  sa is a 32-bit "shift amount" register.
         *
         *  TODO:  Generalize this.
         */
        uint64_t        gpr_quadhi[N_MIPS_GPRS];
        uint64_t        hi1;
        uint64_t        lo1;
        uint32_t        r5900_sa;

        /*  Data and Instruction caches:  */
        unsigned char   *cache[2];
        void            *cache_tags[2];
        uint64_t        cache_last_paddr[2];
        int             cache_size[2];
        int             cache_linesize[2];
        int             cache_mask[2];
        int             cache_miss_penalty[2];


        /*
         *  Instruction translation cache and Virtual->Physical->Host
         *  address translation:
         */
        DYNTRANS_ITC(mips)
        VPH_TLBS(mips,MIPS)
        VPH32(mips,MIPS,uint64_t,uint8_t)
        VPH64(mips,MIPS,uint8_t)
};


/*  cpu_mips.c:  */
void mips_cpu_interrupt_assert(struct interrupt *interrupt);
void mips_cpu_interrupt_deassert(struct interrupt *interrupt);
int mips_cpu_instruction_has_delayslot(struct cpu *cpu, unsigned char *ib);
void mips_cpu_tlbdump(struct machine *m, int x, int rawflag);
void mips_cpu_register_match(struct machine *m, char *name, 
        int writeflag, uint64_t *valuep, int *match_register);
void mips_cpu_register_dump(struct cpu *cpu, int gprs, int coprocs);
int mips_cpu_disassemble_instr(struct cpu *cpu, unsigned char *instr,
        int running, uint64_t addr);
void mips_cpu_exception(struct cpu *cpu, int exccode, int tlb, uint64_t vaddr,
        /*  uint64_t pagemask,  */  int coproc_nr, uint64_t vaddr_vpn2,
        int vaddr_asid, int x_64);
int mips_cpu_run(struct emul *emul, struct machine *machine);
void mips_cpu_dumpinfo(struct cpu *cpu);
void mips_cpu_list_available_types(void);
int mips_cpu_family_init(struct cpu_family *);


/*  cpu_mips_coproc.c:  */
struct mips_coproc *mips_coproc_new(struct cpu *cpu, int coproc_nr);
void mips_coproc_tlb_set_entry(struct cpu *cpu, int entrynr, int size,
        uint64_t vaddr, uint64_t paddr0, uint64_t paddr1,
        int valid0, int valid1, int dirty0, int dirty1, int global, int asid,
        int cachealgo0, int cachealgo1);
void coproc_register_read(struct cpu *cpu,
        struct mips_coproc *cp, int reg_nr, uint64_t *ptr, int select);
void coproc_register_write(struct cpu *cpu,
        struct mips_coproc *cp, int reg_nr, uint64_t *ptr, int flag64,
        int select);
void coproc_tlbpr(struct cpu *cpu, int readflag);
void coproc_tlbwri(struct cpu *cpu, int randomflag);
void coproc_rfe(struct cpu *cpu);
void coproc_eret(struct cpu *cpu);
void coproc_function(struct cpu *cpu, struct mips_coproc *cp, int cpnr,
        uint32_t function, int unassemble_only, int running);


/*  memory_mips.c:  */
int memory_cache_R3000(struct cpu *cpu, int cache, uint64_t paddr,
        int writeflag, size_t len, unsigned char *data);
int mips_memory_rw(struct cpu *cpu, struct memory *mem, uint64_t vaddr,
        unsigned char *data, size_t len, int writeflag, int cache_flags);

int translate_v2p_mmu3k(struct cpu *cpu, uint64_t vaddr,
        uint64_t *return_addr, int flags);
int translate_v2p_mmu8k(struct cpu *cpu, uint64_t vaddr,
        uint64_t *return_addr, int flags);
int translate_v2p_mmu10k(struct cpu *cpu, uint64_t vaddr,
        uint64_t *return_addr, int flags);
int translate_v2p_mmu4100(struct cpu *cpu, uint64_t vaddr,
        uint64_t *return_addr, int flags);
int translate_v2p_generic(struct cpu *cpu, uint64_t vaddr,
        uint64_t *return_addr, int flags);


/*  Dyntrans unaligned load/store:  */
void mips_unaligned_loadstore(struct cpu *cpu, struct mips_instr_call *ic, 
        int is_left, int wlen, int store);


int mips_run_instr(struct cpu *cpu);
void mips_update_translation_table(struct cpu *cpu, uint64_t vaddr_page,
        unsigned char *host_page, int writeflag, uint64_t paddr_page);
void mips_invalidate_translation_caches(struct cpu *cpu, uint64_t, int);
void mips_invalidate_code_translation(struct cpu *cpu, uint64_t, int);
int mips32_run_instr(struct cpu *cpu);
void mips32_update_translation_table(struct cpu *cpu, uint64_t vaddr_page,
        unsigned char *host_page, int writeflag, uint64_t paddr_page);
void mips32_invalidate_translation_caches(struct cpu *cpu, uint64_t, int);
void mips32_invalidate_code_translation(struct cpu *cpu, uint64_t, int);


#endif  /*  CPU_MIPS_H  */
1	#ifndef CPU_MIPS_H
2	#define CPU_MIPS_H
3
4	/*
5	* Copyright (C) 2003-2007 Anders Gavare. All rights reserved.
6	*
7	* Redistribution and use in source and binary forms, with or without
8	* modification, are permitted provided that the following conditions are met:
9	*
10	* 1. Redistributions of source code must retain the above copyright
11	* notice, this list of conditions and the following disclaimer.
12	* 2. Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the distribution.
15	* 3. The name of the author may not be used to endorse or promote products
16	* derived from this software without specific prior written permission.
17	*
18	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21	* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28	* SUCH DAMAGE.
29	*
30	*
31	* $Id: cpu_mips.h,v 1.55 2007/02/07 18:58:32 debug Exp $
32	*/
33
34	#include "interrupt.h"
35	#include "misc.h"
36
37	struct cpu_family;
38	struct emul;
39	struct machine;
40	struct timer;
41
42	/*
43	* CPU type definitions: See mips_cpu_types.h.
44	*/
45
46	struct mips_cpu_type_def {
47	char *name;
48	int rev;
49	int sub;
50	char flags;
51	char exc_model; /* EXC3K or EXC4K */
52	char mmu_model; /* MMU3K or MMU4K */
53	char isa_level; /* 1, 2, 3, 4, 5, 32, 64 */
54	char isa_revision; /* 1 or 2 (for MIPS32/64) */
55	int nr_of_tlb_entries; /* 32, 48, 64, ... */
56	char instrs_per_cycle; /* simplified, 1, 2, or 4 */
57	int picache;
58	int pilinesize;
59	int piways;
60	int pdcache;
61	int pdlinesize;
62	int pdways;
63	int scache;
64	int slinesize;
65	int sways;
66	};
67
68	#define INITIAL_PC 0xffffffffbfc00000ULL
69	#define INITIAL_STACK_POINTER (0xffffffffa0008000ULL - 256)
70
71
72	/*
73	* Coproc 0:
74	*
75	* NOTE:
76	* On R3000, only hi and lo0 are used, and then only the lowest 32 bits.
77	*/
78	#define N_MIPS_COPROC_REGS 32
79	struct mips_tlb {
80	uint64_t hi;
81	uint64_t lo0;
82	uint64_t lo1;
83	uint64_t mask;
84	};
85
86
87	/*
88	* Coproc 1:
89	*/
90	/* FPU control registers: */
91	#define N_MIPS_FCRS 32
92	#define MIPS_FPU_FCIR 0
93	#define MIPS_FPU_FCCR 25
94	#define MIPS_FPU_FCSR 31
95	#define MIPS_FCSR_FCC0_SHIFT 23
96	#define MIPS_FCSR_FCC1_SHIFT 25
97
98	#define N_VADDR_TO_TLB_INDEX_ENTRIES (1 << 20)
99
100	struct mips_coproc {
101	int coproc_nr;
102	uint64_t reg[N_MIPS_COPROC_REGS];
103
104	/* Only for COP0: */
105	struct mips_tlb *tlbs;
106	int nr_of_tlbs;
107
108	/* Only for COP1: floating point control registers */
109	/* (Maybe also for COP0?) */
110	uint64_t fcr[N_MIPS_FCRS];
111	};
112
113	#define N_MIPS_COPROCS 4
114
115	#define N_MIPS_GPRS 32 /* General purpose registers */
116	#define N_MIPS_FPRS 32 /* Floating point registers */
117
118	/*
119	* These should all be 2 characters wide:
120	*
121	* NOTE: These are for 32-bit ABIs. For the 64-bit ABI, registers 8..11
122	* are used to pass arguments and are then called "a4".."a7".
123	*
124	* TODO: Should there be two different variants of this? It's not really
125	* possible to figure out in some easy way if the code running was
126	* written for a 32-bit or 64-bit ABI.
127	*/
128	#define MIPS_REGISTER_NAMES { \
129	"zr", "at", "v0", "v1", "a0", "a1", "a2", "a3", \
130	"t0", "t1", "t2", "t3", "t4", "t5", "t6", "t7", \
131	"s0", "s1", "s2", "s3", "s4", "s5", "s6", "s7", \
132	"t8", "t9", "k0", "k1", "gp", "sp", "fp", "ra" }
133
134	#define MIPS_GPR_ZERO 0 /* zero */
135	#define MIPS_GPR_AT 1 /* at */
136	#define MIPS_GPR_V0 2 /* v0 */
137	#define MIPS_GPR_V1 3 /* v1 */
138	#define MIPS_GPR_A0 4 /* a0 */
139	#define MIPS_GPR_A1 5 /* a1 */
140	#define MIPS_GPR_A2 6 /* a2 */
141	#define MIPS_GPR_A3 7 /* a3 */
142	#define MIPS_GPR_T0 8 /* t0 */
143	#define MIPS_GPR_T1 9 /* t1 */
144	#define MIPS_GPR_T2 10 /* t2 */
145	#define MIPS_GPR_T3 11 /* t3 */
146	#define MIPS_GPR_T4 12 /* t4 */
147	#define MIPS_GPR_T5 13 /* t5 */
148	#define MIPS_GPR_T6 14 /* t6 */
149	#define MIPS_GPR_T7 15 /* t7 */
150	#define MIPS_GPR_S0 16 /* s0 */
151	#define MIPS_GPR_S1 17 /* s1 */
152	#define MIPS_GPR_S2 18 /* s2 */
153	#define MIPS_GPR_S3 19 /* s3 */
154	#define MIPS_GPR_S4 20 /* s4 */
155	#define MIPS_GPR_S5 21 /* s5 */
156	#define MIPS_GPR_S6 22 /* s6 */
157	#define MIPS_GPR_S7 23 /* s7 */
158	#define MIPS_GPR_T8 24 /* t8 */
159	#define MIPS_GPR_T9 25 /* t9 */
160	#define MIPS_GPR_K0 26 /* k0 */
161	#define MIPS_GPR_K1 27 /* k1 */
162	#define MIPS_GPR_GP 28 /* gp */
163	#define MIPS_GPR_SP 29 /* sp */
164	#define MIPS_GPR_FP 30 /* fp */
165	#define MIPS_GPR_RA 31 /* ra */
166
167	#define N_HI6 64
168	#define N_SPECIAL 64
169	#define N_REGIMM 32
170
171
172	/* An "impossible" paddr: */
173	#define IMPOSSIBLE_PADDR 0x1212343456566767ULL
174
175	#define DEFAULT_PCACHE_SIZE 15 /* 32 KB */
176	#define DEFAULT_PCACHE_LINESIZE 5 /* 32 bytes */
177
178	struct r3000_cache_line {
179	uint32_t tag_paddr;
180	int tag_valid;
181	};
182	#define R3000_TAG_VALID 1
183	#define R3000_TAG_DIRTY 2
184
185	struct r4000_cache_line {
186	char dummy;
187	};
188
189
190	#ifdef ONEKPAGE
191	#define MIPS_IC_ENTRIES_SHIFT 8
192	#else
193	#define MIPS_IC_ENTRIES_SHIFT 10
194	#endif
195
196	#define MIPS_N_IC_ARGS 3
197	#define MIPS_INSTR_ALIGNMENT_SHIFT 2
198	#define MIPS_IC_ENTRIES_PER_PAGE (1 << MIPS_IC_ENTRIES_SHIFT)
199	#define MIPS_PC_TO_IC_ENTRY(a) (((a)>>MIPS_INSTR_ALIGNMENT_SHIFT) \
200	& (MIPS_IC_ENTRIES_PER_PAGE-1))
201	#define MIPS_ADDR_TO_PAGENR(a) ((a) >> (MIPS_IC_ENTRIES_SHIFT \
202	+ MIPS_INSTR_ALIGNMENT_SHIFT))
203
204	#define MIPS_L2N 17
205	#define MIPS_L3N 18
206
207	#define MIPS_MAX_VPH_TLB_ENTRIES 128
208	DYNTRANS_MISC_DECLARATIONS(mips,MIPS,uint64_t)
209	DYNTRANS_MISC64_DECLARATIONS(mips,MIPS,uint8_t)
210
211
212	struct mips_cpu {
213	struct mips_cpu_type_def cpu_type;
214
215	/* General purpose registers: */
216	uint64_t gpr[N_MIPS_GPRS];
217
218	/* Dummy destination register when writing to the zero register: */
219	uint64_t scratch;
220
221	/* Special purpose registers: */
222	uint64_t hi;
223	uint64_t lo;
224
225	/* Coprocessors: */
226	struct mips_coproc *coproc[N_MIPS_COPROCS];
227	uint64_t cop0_config_select1;
228
229	int last_written_tlb_index;
230
231	/* Count/compare timer: */
232	int compare_register_set;
233	int compare_interrupts_pending;
234	struct interrupt irq_compare;
235	struct timer *timer;
236
237	int rmw; /* Read-Modify-Write */
238	int rmw_len; /* Length of rmw modification */
239	uint64_t rmw_addr; /* Address of rmw modification */
240
241	/*
242	* NOTE: The R5900 has 128-bit registers. I'm not really sure
243	* whether they are used a lot or not, at least with code produced
244	* with gcc they are not. An important case however is lq and sq
245	* (load and store of 128-bit values). These "upper halves" of R5900
246	* quadwords can be used in those cases.
247	*
248	* hi1 and lo1 are the high 64-bit parts of the hi and lo registers.
249	* sa is a 32-bit "shift amount" register.
250	*
251	* TODO: Generalize this.
252	*/
253	uint64_t gpr_quadhi[N_MIPS_GPRS];
254	uint64_t hi1;
255	uint64_t lo1;
256	uint32_t r5900_sa;
257
258	/* Data and Instruction caches: */
259	unsigned char *cache[2];
260	void *cache_tags[2];
261	uint64_t cache_last_paddr[2];
262	int cache_size[2];
263	int cache_linesize[2];
264	int cache_mask[2];
265	int cache_miss_penalty[2];
266
267
268	/*
269	* Instruction translation cache and Virtual->Physical->Host
270	* address translation:
271	*/
272	DYNTRANS_ITC(mips)
273	VPH_TLBS(mips,MIPS)
274	VPH32(mips,MIPS,uint64_t,uint8_t)
275	VPH64(mips,MIPS,uint8_t)
276	};
277
278
279	/* cpu_mips.c: */
280	void mips_cpu_interrupt_assert(struct interrupt *interrupt);
281	void mips_cpu_interrupt_deassert(struct interrupt *interrupt);
282	int mips_cpu_instruction_has_delayslot(struct cpu cpu, unsigned char ib);
283	void mips_cpu_tlbdump(struct machine *m, int x, int rawflag);
284	void mips_cpu_register_match(struct machine m, char name,
285	int writeflag, uint64_t valuep, int match_register);
286	void mips_cpu_register_dump(struct cpu *cpu, int gprs, int coprocs);
287	int mips_cpu_disassemble_instr(struct cpu cpu, unsigned char instr,
288	int running, uint64_t addr);
289	void mips_cpu_exception(struct cpu *cpu, int exccode, int tlb, uint64_t vaddr,
290	/* uint64_t pagemask, */ int coproc_nr, uint64_t vaddr_vpn2,
291	int vaddr_asid, int x_64);
292	int mips_cpu_run(struct emul emul, struct machine machine);
293	void mips_cpu_dumpinfo(struct cpu *cpu);
294	void mips_cpu_list_available_types(void);
295	int mips_cpu_family_init(struct cpu_family *);
296
297
298	/* cpu_mips_coproc.c: */
299	struct mips_coproc mips_coproc_new(struct cpu cpu, int coproc_nr);
300	void mips_coproc_tlb_set_entry(struct cpu *cpu, int entrynr, int size,
301	uint64_t vaddr, uint64_t paddr0, uint64_t paddr1,
302	int valid0, int valid1, int dirty0, int dirty1, int global, int asid,
303	int cachealgo0, int cachealgo1);
304	void coproc_register_read(struct cpu *cpu,
305	struct mips_coproc cp, int reg_nr, uint64_t ptr, int select);
306	void coproc_register_write(struct cpu *cpu,
307	struct mips_coproc cp, int reg_nr, uint64_t ptr, int flag64,
308	int select);
309	void coproc_tlbpr(struct cpu *cpu, int readflag);
310	void coproc_tlbwri(struct cpu *cpu, int randomflag);
311	void coproc_rfe(struct cpu *cpu);
312	void coproc_eret(struct cpu *cpu);
313	void coproc_function(struct cpu cpu, struct mips_coproc cp, int cpnr,
314	uint32_t function, int unassemble_only, int running);
315
316
317	/* memory_mips.c: */
318	int memory_cache_R3000(struct cpu *cpu, int cache, uint64_t paddr,
319	int writeflag, size_t len, unsigned char *data);
320	int mips_memory_rw(struct cpu cpu, struct memory mem, uint64_t vaddr,
321	unsigned char *data, size_t len, int writeflag, int cache_flags);
322
323	int translate_v2p_mmu3k(struct cpu *cpu, uint64_t vaddr,
324	uint64_t *return_addr, int flags);
325	int translate_v2p_mmu8k(struct cpu *cpu, uint64_t vaddr,
326	uint64_t *return_addr, int flags);
327	int translate_v2p_mmu10k(struct cpu *cpu, uint64_t vaddr,
328	uint64_t *return_addr, int flags);
329	int translate_v2p_mmu4100(struct cpu *cpu, uint64_t vaddr,
330	uint64_t *return_addr, int flags);
331	int translate_v2p_generic(struct cpu *cpu, uint64_t vaddr,
332	uint64_t *return_addr, int flags);
333
334
335	/* Dyntrans unaligned load/store: */
336	void mips_unaligned_loadstore(struct cpu cpu, struct mips_instr_call ic,
337	int is_left, int wlen, int store);
338
339
340	int mips_run_instr(struct cpu *cpu);
341	void mips_update_translation_table(struct cpu *cpu, uint64_t vaddr_page,
342	unsigned char *host_page, int writeflag, uint64_t paddr_page);
343	void mips_invalidate_translation_caches(struct cpu *cpu, uint64_t, int);
344	void mips_invalidate_code_translation(struct cpu *cpu, uint64_t, int);
345	int mips32_run_instr(struct cpu *cpu);
346	void mips32_update_translation_table(struct cpu *cpu, uint64_t vaddr_page,
347	unsigned char *host_page, int writeflag, uint64_t paddr_page);
348	void mips32_invalidate_translation_caches(struct cpu *cpu, uint64_t, int);
349	void mips32_invalidate_code_translation(struct cpu *cpu, uint64_t, int);
350
351
352	#endif /* CPU_MIPS_H */