1 |
#ifndef CPU_ARM_H |
2 |
#define CPU_ARM_H |
3 |
|
4 |
/* |
5 |
* Copyright (C) 2005 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_arm.h,v 1.57 2005/11/16 21:15:19 debug Exp $ |
32 |
*/ |
33 |
|
34 |
#include "misc.h" |
35 |
|
36 |
|
37 |
struct cpu_family; |
38 |
|
39 |
/* ARM CPU types: */ |
40 |
struct arm_cpu_type_def { |
41 |
char *name; |
42 |
uint32_t cpu_id; |
43 |
int flags; |
44 |
int icache_shift; |
45 |
int iway; |
46 |
int dcache_shift; |
47 |
int dway; |
48 |
}; |
49 |
|
50 |
|
51 |
#define ARM_SL 10 |
52 |
#define ARM_FP 11 |
53 |
#define ARM_IP 12 |
54 |
#define ARM_SP 13 |
55 |
#define ARM_LR 14 |
56 |
#define ARM_PC 15 |
57 |
#define N_ARM_REGS 16 |
58 |
|
59 |
#define ARM_REG_NAMES { \ |
60 |
"r0", "r1", "r2", "r3", "r4", "r5", "r6", "r7", \ |
61 |
"r8", "r9", "sl", "fp", "ip", "sp", "lr", "pc" } |
62 |
|
63 |
#define ARM_CONDITION_STRINGS { \ |
64 |
"eq", "ne", "cs", "cc", "mi", "pl", "vs", "vc", \ |
65 |
"hi", "ls", "ge", "lt", "gt", "le", "" /*Always*/ , "(INVALID)" } |
66 |
|
67 |
/* Names of Data Processing Instructions: */ |
68 |
#define ARM_DPI_NAMES { \ |
69 |
"and", "eor", "sub", "rsb", "add", "adc", "sbc", "rsc", \ |
70 |
"tst", "teq", "cmp", "cmn", "orr", "mov", "bic", "mvn" } |
71 |
|
72 |
#define ARM_N_IC_ARGS 3 |
73 |
#define ARM_INSTR_ALIGNMENT_SHIFT 2 |
74 |
#define ARM_IC_ENTRIES_SHIFT 10 |
75 |
#define ARM_IC_ENTRIES_PER_PAGE (1 << ARM_IC_ENTRIES_SHIFT) |
76 |
#define ARM_PC_TO_IC_ENTRY(a) (((a)>>ARM_INSTR_ALIGNMENT_SHIFT) \ |
77 |
& (ARM_IC_ENTRIES_PER_PAGE-1)) |
78 |
#define ARM_ADDR_TO_PAGENR(a) ((a) >> (ARM_IC_ENTRIES_SHIFT \ |
79 |
+ ARM_INSTR_ALIGNMENT_SHIFT)) |
80 |
|
81 |
struct arm_instr_call { |
82 |
void (*f)(struct cpu *, struct arm_instr_call *); |
83 |
size_t arg[ARM_N_IC_ARGS]; |
84 |
}; |
85 |
|
86 |
/* Translation cache struct for each physical page: */ |
87 |
struct arm_tc_physpage { |
88 |
struct arm_instr_call ics[ARM_IC_ENTRIES_PER_PAGE + 1]; |
89 |
uint32_t next_ofs; /* or 0 for end of chain */ |
90 |
uint32_t physaddr; |
91 |
int flags; |
92 |
}; |
93 |
|
94 |
|
95 |
#define ARM_F_N 8 /* Same as ARM_FLAG_*, but */ |
96 |
#define ARM_F_Z 4 /* for the 'flags' field instead */ |
97 |
#define ARM_F_C 2 /* of cpsr. */ |
98 |
#define ARM_F_V 1 |
99 |
|
100 |
#define ARM_FLAG_N 0x80000000 /* Negative flag */ |
101 |
#define ARM_FLAG_Z 0x40000000 /* Zero flag */ |
102 |
#define ARM_FLAG_C 0x20000000 /* Carry flag */ |
103 |
#define ARM_FLAG_V 0x10000000 /* Overflow flag */ |
104 |
#define ARM_FLAG_Q 0x08000000 /* DSP saturation overflow */ |
105 |
#define ARM_FLAG_I 0x00000080 /* Interrupt disable */ |
106 |
#define ARM_FLAG_F 0x00000040 /* Fast Interrupt disable */ |
107 |
#define ARM_FLAG_T 0x00000020 /* Thumb mode */ |
108 |
|
109 |
#define ARM_FLAG_MODE 0x0000001f |
110 |
#define ARM_MODE_USR26 0x00 |
111 |
#define ARM_MODE_FIQ26 0x01 |
112 |
#define ARM_MODE_IRQ26 0x02 |
113 |
#define ARM_MODE_SVC26 0x03 |
114 |
#define ARM_MODE_USR32 0x10 |
115 |
#define ARM_MODE_FIQ32 0x11 |
116 |
#define ARM_MODE_IRQ32 0x12 |
117 |
#define ARM_MODE_SVC32 0x13 |
118 |
#define ARM_MODE_ABT32 0x17 |
119 |
#define ARM_MODE_UND32 0x1b |
120 |
#define ARM_MODE_SYS32 0x1f |
121 |
|
122 |
#define ARM_EXCEPTION_TO_MODE { \ |
123 |
ARM_MODE_SVC32, ARM_MODE_UND32, ARM_MODE_SVC32, ARM_MODE_ABT32, \ |
124 |
ARM_MODE_ABT32, 0, ARM_MODE_IRQ32, ARM_MODE_FIQ32 } |
125 |
|
126 |
#define N_ARM_EXCEPTIONS 8 |
127 |
|
128 |
#define ARM_EXCEPTION_RESET 0 |
129 |
#define ARM_EXCEPTION_UND 1 |
130 |
#define ARM_EXCEPTION_SWI 2 |
131 |
#define ARM_EXCEPTION_PREF_ABT 3 |
132 |
#define ARM_EXCEPTION_DATA_ABT 4 |
133 |
/* 5 was address exception in 26-bit ARM */ |
134 |
#define ARM_EXCEPTION_IRQ 6 |
135 |
#define ARM_EXCEPTION_FIQ 7 |
136 |
|
137 |
|
138 |
#define ARM_N_VPH_ENTRIES 1048576 |
139 |
|
140 |
#define ARM_MAX_VPH_TLB_ENTRIES 128 |
141 |
struct arm_vpg_tlb_entry { |
142 |
unsigned char valid; |
143 |
unsigned char writeflag; |
144 |
uint32_t vaddr_page; |
145 |
uint32_t paddr_page; |
146 |
unsigned char *host_page; |
147 |
}; |
148 |
|
149 |
|
150 |
struct arm_cpu { |
151 |
/* |
152 |
* Misc.: |
153 |
*/ |
154 |
struct arm_cpu_type_def cpu_type; |
155 |
uint32_t of_emul_addr; |
156 |
|
157 |
void (*coproc[16])(struct cpu *, int opcode1, |
158 |
int opcode2, int l_bit, int crn, int crm, |
159 |
int rd); |
160 |
|
161 |
/* |
162 |
* General Purpose Registers (including the program counter): |
163 |
* |
164 |
* r[] always contains the current register set. The others are |
165 |
* only used to swap to/from when changing modes. (An exception is |
166 |
* r[0..7], which are never swapped out, they are always present.) |
167 |
*/ |
168 |
|
169 |
uint32_t r[N_ARM_REGS]; |
170 |
|
171 |
uint32_t default_r8_r14[7]; /* usr and sys */ |
172 |
uint32_t fiq_r8_r14[7]; |
173 |
uint32_t irq_r13_r14[2]; |
174 |
uint32_t svc_r13_r14[2]; |
175 |
uint32_t abt_r13_r14[2]; |
176 |
uint32_t und_r13_r14[2]; |
177 |
|
178 |
uint32_t tmp_pc; /* Used for load/stores */ |
179 |
|
180 |
/* |
181 |
* Flag/status registers: |
182 |
* |
183 |
* NOTE: 'flags' just contains the 4 flag bits. When cpsr is read, |
184 |
* the flags should be copied from 'flags', and when cpsr is written |
185 |
* to, 'flags' should be updated as well. |
186 |
*/ |
187 |
size_t flags; |
188 |
uint32_t cpsr; |
189 |
uint32_t spsr_svc; |
190 |
uint32_t spsr_abt; |
191 |
uint32_t spsr_und; |
192 |
uint32_t spsr_irq; |
193 |
uint32_t spsr_fiq; |
194 |
|
195 |
|
196 |
/* |
197 |
* System Control Coprocessor registers: |
198 |
*/ |
199 |
uint32_t control; |
200 |
uint32_t ttb; /* Translation Table Base */ |
201 |
uint32_t dacr; /* Domain Access Control */ |
202 |
uint32_t fsr; /* Fault Status Register */ |
203 |
uint32_t far; /* Fault Address Register */ |
204 |
uint32_t pid; /* Process Id Register */ |
205 |
|
206 |
/* For caching the host address of the L1 translation table: */ |
207 |
unsigned char *translation_table; |
208 |
uint32_t last_ttb; |
209 |
|
210 |
|
211 |
/* |
212 |
* Interrupts: |
213 |
*/ |
214 |
int irq_asserted; |
215 |
|
216 |
|
217 |
/* |
218 |
* Instruction translation cache: |
219 |
*/ |
220 |
|
221 |
/* cur_ic_page is a pointer to an array of ARM_IC_ENTRIES_PER_PAGE |
222 |
instruction call entries. next_ic points to the next such |
223 |
call to be executed. */ |
224 |
struct arm_tc_physpage *cur_physpage; |
225 |
struct arm_instr_call *cur_ic_page; |
226 |
struct arm_instr_call *next_ic; |
227 |
|
228 |
void (*combination_check)(struct cpu *, |
229 |
struct arm_instr_call *, int low_addr); |
230 |
|
231 |
/* |
232 |
* Virtual -> physical -> host address translation: |
233 |
* |
234 |
* host_load and host_store point to arrays of ARM_N_VPH_ENTRIES |
235 |
* pointers (to host pages); phys_addr points to an array of |
236 |
* ARM_N_VPH_ENTRIES uint32_t. |
237 |
*/ |
238 |
|
239 |
struct arm_vpg_tlb_entry vph_tlb_entry[ARM_MAX_VPH_TLB_ENTRIES]; |
240 |
unsigned char *host_load[ARM_N_VPH_ENTRIES]; |
241 |
unsigned char *host_store[ARM_N_VPH_ENTRIES]; |
242 |
uint32_t phys_addr[ARM_N_VPH_ENTRIES]; |
243 |
struct arm_tc_physpage *phys_page[ARM_N_VPH_ENTRIES]; |
244 |
|
245 |
uint32_t phystranslation[ARM_N_VPH_ENTRIES/32]; |
246 |
uint8_t vaddr_to_tlbindex[ARM_N_VPH_ENTRIES]; |
247 |
|
248 |
/* ARM specific: */ |
249 |
uint32_t is_userpage[ARM_N_VPH_ENTRIES/32]; |
250 |
}; |
251 |
|
252 |
|
253 |
/* System Control Coprocessor, control bits: */ |
254 |
#define ARM_CONTROL_MMU 0x0001 |
255 |
#define ARM_CONTROL_ALIGN 0x0002 |
256 |
#define ARM_CONTROL_CACHE 0x0004 |
257 |
#define ARM_CONTROL_WBUFFER 0x0008 |
258 |
#define ARM_CONTROL_PROG32 0x0010 |
259 |
#define ARM_CONTROL_DATA32 0x0020 |
260 |
#define ARM_CONTROL_BIG 0x0080 |
261 |
#define ARM_CONTROL_S 0x0100 |
262 |
#define ARM_CONTROL_R 0x0200 |
263 |
#define ARM_CONTROL_F 0x0400 |
264 |
#define ARM_CONTROL_Z 0x0800 |
265 |
#define ARM_CONTROL_ICACHE 0x1000 |
266 |
#define ARM_CONTROL_V 0x2000 |
267 |
#define ARM_CONTROL_RR 0x4000 |
268 |
#define ARM_CONTROL_L4 0x8000 |
269 |
|
270 |
/* cpu_arm.c: */ |
271 |
void arm_setup_initial_translation_table(struct cpu *cpu, uint32_t ttb_addr); |
272 |
void arm_translation_table_set_l1(struct cpu *cpu, uint32_t vaddr, |
273 |
uint32_t paddr); |
274 |
void arm_translation_table_set_l1_b(struct cpu *cpu, uint32_t vaddr, |
275 |
uint32_t paddr); |
276 |
void arm_exception(struct cpu *, int); |
277 |
void arm_update_translation_table(struct cpu *cpu, uint64_t vaddr_page, |
278 |
unsigned char *host_page, int writeflag, uint64_t paddr_page); |
279 |
void arm_invalidate_translation_caches(struct cpu *cpu, uint64_t, int); |
280 |
void arm_invalidate_code_translation(struct cpu *cpu, uint64_t, int); |
281 |
void arm_load_register_bank(struct cpu *cpu); |
282 |
void arm_save_register_bank(struct cpu *cpu); |
283 |
int arm_memory_rw(struct cpu *cpu, struct memory *mem, uint64_t vaddr, |
284 |
unsigned char *data, size_t len, int writeflag, int cache_flags); |
285 |
int arm_cpu_family_init(struct cpu_family *); |
286 |
|
287 |
/* cpu_arm_coproc.c: */ |
288 |
void arm_coproc_15(struct cpu *cpu, int opcode1, int opcode2, int l_bit, |
289 |
int crn, int crm, int rd); |
290 |
void arm_coproc_i80321(struct cpu *cpu, int opcode1, int opcode2, int l_bit, |
291 |
int crn, int crm, int rd); |
292 |
void arm_coproc_i80321_14(struct cpu *cpu, int opcode1, int opcode2, int l_bit, |
293 |
int crn, int crm, int rd); |
294 |
|
295 |
/* memory_arm.c: */ |
296 |
int arm_translate_address(struct cpu *cpu, uint64_t vaddr, |
297 |
uint64_t *return_addr, int flags); |
298 |
int arm_translate_address_mmu(struct cpu *cpu, uint64_t vaddr, |
299 |
uint64_t *return_addr, int flags); |
300 |
|
301 |
#endif /* CPU_ARM_H */ |