sim: replace CIA_{GET,SET} with CPU_PC_{GET,SET}
[deliverable/binutils-gdb.git] / sim / m68hc11 / sim-main.h
1 /* sim-main.h -- Simulator for Motorola 68HC11 & 68HC12
2 Copyright (C) 1999-2015 Free Software Foundation, Inc.
3 Written by Stephane Carrez (stcarrez@nerim.fr)
4
5 This file is part of GDB, the GNU debugger.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
19
20 #ifndef _SIM_MAIN_H
21 #define _SIM_MAIN_H
22
23 #define WITH_MODULO_MEMORY 1
24 #define WITH_WATCHPOINTS 1
25 #define SIM_HANDLES_LMA 1
26
27 #include "sim-basics.h"
28
29 typedef address_word sim_cia;
30
31 typedef struct _sim_cpu SIM_CPU;
32
33 #include "sim-signal.h"
34 #include "sim-base.h"
35
36 #include "bfd.h"
37
38 #include "opcode/m68hc11.h"
39
40 #include "gdb/callback.h"
41 #include "gdb/remote-sim.h"
42 #include "opcode/m68hc11.h"
43 #include "sim-types.h"
44
45 typedef unsigned8 uint8;
46 typedef unsigned16 uint16;
47 typedef signed16 int16;
48 typedef unsigned32 uint32;
49 typedef signed32 int32;
50 typedef unsigned64 uint64;
51 typedef signed64 int64;
52
53 struct _sim_cpu;
54
55 #include "interrupts.h"
56 #include <setjmp.h>
57
58 /* Specifies the level of mapping for the IO, EEprom, nvram and external
59 RAM. IO registers are mapped over everything and the external RAM
60 is last (ie, it can be hidden by everything above it in the list). */
61 enum m68hc11_map_level
62 {
63 M6811_IO_LEVEL,
64 M6811_EEPROM_LEVEL,
65 M6811_NVRAM_LEVEL,
66 M6811_RAM_LEVEL
67 };
68
69 enum cpu_type
70 {
71 CPU_M6811,
72 CPU_M6812
73 };
74
75 #define X_REGNUM 0
76 #define D_REGNUM 1
77 #define Y_REGNUM 2
78 #define SP_REGNUM 3
79 #define PC_REGNUM 4
80 #define A_REGNUM 5
81 #define B_REGNUM 6
82 #define PSW_REGNUM 7
83 #define PAGE_REGNUM 8
84 #define Z_REGNUM 9
85
86 typedef struct m6811_regs {
87 unsigned short d;
88 unsigned short ix;
89 unsigned short iy;
90 unsigned short sp;
91 unsigned short pc;
92 unsigned char ccr;
93 unsigned short page;
94 } m6811_regs;
95
96
97 /* Description of 68HC11 IO registers. Such description is only provided
98 for the info command to display the current setting of IO registers
99 from GDB. */
100 struct io_reg_desc
101 {
102 int mask;
103 const char *short_name;
104 const char *long_name;
105 };
106 typedef struct io_reg_desc io_reg_desc;
107
108 extern void print_io_reg_desc (SIM_DESC sd, io_reg_desc *desc, int val,
109 int mode);
110 extern void print_io_byte (SIM_DESC sd, const char *name,
111 io_reg_desc *desc, uint8 val, uint16 addr);
112 extern void print_io_word (SIM_DESC sd, const char *name,
113 io_reg_desc *desc, uint16 val, uint16 addr);
114
115
116 /* List of special 68HC11&68HC12 instructions that are not handled by the
117 'gencode.c' generator. These complex instructions are implemented
118 by 'cpu_special'. */
119 enum M6811_Special
120 {
121 /* 68HC11 instructions. */
122 M6811_DAA,
123 M6811_EMUL_SYSCALL,
124 M6811_ILLEGAL,
125 M6811_RTI,
126 M6811_STOP,
127 M6811_SWI,
128 M6811_TEST,
129 M6811_WAI,
130
131 /* 68HC12 instructions. */
132 M6812_BGND,
133 M6812_CALL,
134 M6812_CALL_INDIRECT,
135 M6812_IDIVS,
136 M6812_EDIV,
137 M6812_EDIVS,
138 M6812_EMACS,
139 M6812_EMUL,
140 M6812_EMULS,
141 M6812_ETBL,
142 M6812_MEM,
143 M6812_REV,
144 M6812_REVW,
145 M6812_RTC,
146 M6812_RTI,
147 M6812_WAV
148 };
149
150 #define M6811_MAX_PORTS (0x03f+1)
151 #define M6812_MAX_PORTS (0x3ff+1)
152 #define MAX_PORTS (M6812_MAX_PORTS)
153
154 struct _sim_cpu;
155
156 typedef void (* cpu_interp) (struct _sim_cpu*);
157
158 struct _sim_cpu {
159 /* CPU registers. */
160 struct m6811_regs cpu_regs;
161
162 /* CPU interrupts. */
163 struct interrupts cpu_interrupts;
164
165 /* Pointer to the interpretor routine. */
166 cpu_interp cpu_interpretor;
167
168 /* Pointer to the architecture currently configured in the simulator. */
169 const struct bfd_arch_info *cpu_configured_arch;
170
171 /* CPU absolute cycle time. The cycle time is updated after
172 each instruction, by the number of cycles taken by the instruction.
173 It is cleared only when reset occurs. */
174 signed64 cpu_absolute_cycle;
175
176 /* Number of cycles to increment after the current instruction.
177 This is also the number of ticks for the generic event scheduler. */
178 uint8 cpu_current_cycle;
179 int cpu_emul_syscall;
180 int cpu_is_initialized;
181 int cpu_running;
182 int cpu_check_memory;
183 int cpu_stop_on_interrupt;
184
185 /* When this is set, start execution of program at address specified
186 in the ELF header. This is used for testing some programs that do not
187 have an interrupt table linked with them. Programs created during the
188 GCC validation are like this. A normal 68HC11 does not behave like
189 this (unless there is some OS or downloadable feature). */
190 int cpu_use_elf_start;
191
192 /* The starting address specified in ELF header. */
193 int cpu_elf_start;
194
195 uint16 cpu_insn_pc;
196
197 /* CPU frequency. This is the quartz frequency. It is divided by 4 to
198 get the cycle time. This is used for the timer rate and for the baud
199 rate generation. */
200 unsigned long cpu_frequency;
201
202 /* The mode in which the CPU is configured (MODA and MODB pins). */
203 unsigned int cpu_mode;
204 const char* cpu_start_mode;
205
206 /* The cpu being configured. */
207 enum cpu_type cpu_type;
208
209 /* Initial value of the CONFIG register. */
210 uint8 cpu_config;
211 uint8 cpu_use_local_config;
212
213 uint8 ios[MAX_PORTS];
214
215 /* Memory bank parameters which describe how the memory bank window
216 is mapped in memory and how to convert it in virtual address. */
217 uint16 bank_start;
218 uint16 bank_end;
219 address_word bank_virtual;
220 unsigned bank_shift;
221
222
223 struct hw *hw_cpu;
224
225 /* ... base type ... */
226 sim_cpu_base base;
227 };
228
229 /* Returns the cpu absolute cycle time (A virtual counter incremented
230 at each 68HC11 E clock). */
231 #define cpu_current_cycle(PROC) ((PROC)->cpu_absolute_cycle)
232 #define cpu_add_cycles(PROC,T) ((PROC)->cpu_current_cycle += (signed64) (T))
233 #define cpu_is_running(PROC) ((PROC)->cpu_running)
234
235 /* Get the IO/RAM base addresses depending on the M6811_INIT register. */
236 #define cpu_get_io_base(PROC) \
237 (((uint16)(((PROC)->ios[M6811_INIT]) & 0x0F))<<12)
238 #define cpu_get_reg_base(PROC) \
239 (((uint16)(((PROC)->ios[M6811_INIT]) & 0xF0))<<8)
240
241 /* Returns the different CPU registers. */
242 #define cpu_get_ccr(PROC) ((PROC)->cpu_regs.ccr)
243 #define cpu_get_pc(PROC) ((PROC)->cpu_regs.pc)
244 #define cpu_get_d(PROC) ((PROC)->cpu_regs.d)
245 #define cpu_get_x(PROC) ((PROC)->cpu_regs.ix)
246 #define cpu_get_y(PROC) ((PROC)->cpu_regs.iy)
247 #define cpu_get_sp(PROC) ((PROC)->cpu_regs.sp)
248 #define cpu_get_a(PROC) ((PROC->cpu_regs.d >> 8) & 0x0FF)
249 #define cpu_get_b(PROC) ((PROC->cpu_regs.d) & 0x0FF)
250 #define cpu_get_page(PROC) ((PROC)->cpu_regs.page)
251
252 /* 68HC12 specific and Motorola internal registers. */
253 #define cpu_get_tmp3(PROC) (0)
254 #define cpu_get_tmp2(PROC) (0)
255
256 #define cpu_set_d(PROC,VAL) (((PROC)->cpu_regs.d) = (VAL))
257 #define cpu_set_x(PROC,VAL) (((PROC)->cpu_regs.ix) = (VAL))
258 #define cpu_set_y(PROC,VAL) (((PROC)->cpu_regs.iy) = (VAL))
259 #define cpu_set_page(PROC,VAL) (((PROC)->cpu_regs.page) = (VAL))
260
261 /* 68HC12 specific and Motorola internal registers. */
262 #define cpu_set_tmp3(PROC,VAL) (0)
263 #define cpu_set_tmp2(PROC,VAL) (void) (0)
264
265 #if 0
266 /* This is a function in m68hc11_sim.c to keep track of the frame. */
267 #define cpu_set_sp(PROC,VAL) (((PROC)->cpu_regs.sp) = (VAL))
268 #endif
269
270 #define cpu_set_pc(PROC,VAL) (((PROC)->cpu_regs.pc) = (VAL))
271
272 #define cpu_set_a(PROC,VAL) \
273 cpu_set_d(PROC,((VAL) << 8) | cpu_get_b(PROC))
274 #define cpu_set_b(PROC,VAL) \
275 cpu_set_d(PROC,((cpu_get_a(PROC)) << 8)|(VAL & 0x0FF))
276
277 #define cpu_set_ccr(PROC,VAL) ((PROC)->cpu_regs.ccr = (VAL))
278 #define cpu_get_ccr_H(PROC) ((cpu_get_ccr(PROC) & M6811_H_BIT) ? 1: 0)
279 #define cpu_get_ccr_X(PROC) ((cpu_get_ccr(PROC) & M6811_X_BIT) ? 1: 0)
280 #define cpu_get_ccr_S(PROC) ((cpu_get_ccr(PROC) & M6811_S_BIT) ? 1: 0)
281 #define cpu_get_ccr_N(PROC) ((cpu_get_ccr(PROC) & M6811_N_BIT) ? 1: 0)
282 #define cpu_get_ccr_V(PROC) ((cpu_get_ccr(PROC) & M6811_V_BIT) ? 1: 0)
283 #define cpu_get_ccr_C(PROC) ((cpu_get_ccr(PROC) & M6811_C_BIT) ? 1: 0)
284 #define cpu_get_ccr_Z(PROC) ((cpu_get_ccr(PROC) & M6811_Z_BIT) ? 1: 0)
285 #define cpu_get_ccr_I(PROC) ((cpu_get_ccr(PROC) & M6811_I_BIT) ? 1: 0)
286
287 #define cpu_set_ccr_flag(S,B,V) \
288 cpu_set_ccr(S,(cpu_get_ccr(S) & ~(B)) | ((V) ? B : 0))
289
290 #define cpu_set_ccr_H(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_H_BIT, VAL)
291 #define cpu_set_ccr_X(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_X_BIT, VAL)
292 #define cpu_set_ccr_S(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_S_BIT, VAL)
293 #define cpu_set_ccr_N(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_N_BIT, VAL)
294 #define cpu_set_ccr_V(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_V_BIT, VAL)
295 #define cpu_set_ccr_C(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_C_BIT, VAL)
296 #define cpu_set_ccr_Z(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_Z_BIT, VAL)
297 #define cpu_set_ccr_I(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_I_BIT, VAL)
298
299 #undef inline
300 #define inline static __inline__
301
302 extern void cpu_memory_exception (struct _sim_cpu *proc,
303 SIM_SIGNAL excep,
304 uint16 addr,
305 const char *message);
306
307 inline address_word
308 phys_to_virt (sim_cpu *cpu, address_word addr)
309 {
310 if (addr >= cpu->bank_start && addr < cpu->bank_end)
311 return ((address_word) (addr - cpu->bank_start)
312 + (((address_word) cpu->cpu_regs.page) << cpu->bank_shift)
313 + cpu->bank_virtual);
314 else
315 return (address_word) (addr);
316 }
317
318 inline uint8
319 memory_read8 (sim_cpu *cpu, uint16 addr)
320 {
321 uint8 val;
322
323 if (sim_core_read_buffer (CPU_STATE (cpu), cpu, 0, &val, addr, 1) != 1)
324 {
325 cpu_memory_exception (cpu, SIM_SIGSEGV, addr,
326 "Read error");
327 }
328 return val;
329 }
330
331 inline void
332 memory_write8 (sim_cpu *cpu, uint16 addr, uint8 val)
333 {
334 if (sim_core_write_buffer (CPU_STATE (cpu), cpu, 0, &val, addr, 1) != 1)
335 {
336 cpu_memory_exception (cpu, SIM_SIGSEGV, addr,
337 "Write error");
338 }
339 }
340
341 inline uint16
342 memory_read16 (sim_cpu *cpu, uint16 addr)
343 {
344 uint8 b[2];
345
346 if (sim_core_read_buffer (CPU_STATE (cpu), cpu, 0, b, addr, 2) != 2)
347 {
348 cpu_memory_exception (cpu, SIM_SIGSEGV, addr,
349 "Read error");
350 }
351 return (((uint16) (b[0])) << 8) | ((uint16) b[1]);
352 }
353
354 inline void
355 memory_write16 (sim_cpu *cpu, uint16 addr, uint16 val)
356 {
357 uint8 b[2];
358
359 b[0] = val >> 8;
360 b[1] = val;
361 if (sim_core_write_buffer (CPU_STATE (cpu), cpu, 0, b, addr, 2) != 2)
362 {
363 cpu_memory_exception (cpu, SIM_SIGSEGV, addr,
364 "Write error");
365 }
366 }
367 extern void
368 cpu_ccr_update_tst8 (sim_cpu *proc, uint8 val);
369
370 inline void
371 cpu_ccr_update_tst16 (sim_cpu *proc, uint16 val)
372 {
373 cpu_set_ccr_V (proc, 0);
374 cpu_set_ccr_N (proc, val & 0x8000 ? 1 : 0);
375 cpu_set_ccr_Z (proc, val == 0 ? 1 : 0);
376 }
377
378 inline void
379 cpu_ccr_update_shift8 (sim_cpu *proc, uint8 val)
380 {
381 cpu_set_ccr_N (proc, val & 0x80 ? 1 : 0);
382 cpu_set_ccr_Z (proc, val == 0 ? 1 : 0);
383 cpu_set_ccr_V (proc, cpu_get_ccr_N (proc) ^ cpu_get_ccr_C (proc));
384 }
385
386 inline void
387 cpu_ccr_update_shift16 (sim_cpu *proc, uint16 val)
388 {
389 cpu_set_ccr_N (proc, val & 0x8000 ? 1 : 0);
390 cpu_set_ccr_Z (proc, val == 0 ? 1 : 0);
391 cpu_set_ccr_V (proc, cpu_get_ccr_N (proc) ^ cpu_get_ccr_C (proc));
392 }
393
394 inline void
395 cpu_ccr_update_add8 (sim_cpu *proc, uint8 r, uint8 a, uint8 b)
396 {
397 cpu_set_ccr_C (proc, ((a & b) | (b & ~r) | (a & ~r)) & 0x80 ? 1 : 0);
398 cpu_set_ccr_V (proc, ((a & b & ~r) | (~a & ~b & r)) & 0x80 ? 1 : 0);
399 cpu_set_ccr_Z (proc, r == 0);
400 cpu_set_ccr_N (proc, r & 0x80 ? 1 : 0);
401 }
402
403
404 inline void
405 cpu_ccr_update_sub8 (sim_cpu *proc, uint8 r, uint8 a, uint8 b)
406 {
407 cpu_set_ccr_C (proc, ((~a & b) | (b & r) | (~a & r)) & 0x80 ? 1 : 0);
408 cpu_set_ccr_V (proc, ((a & ~b & ~r) | (~a & b & r)) & 0x80 ? 1 : 0);
409 cpu_set_ccr_Z (proc, r == 0);
410 cpu_set_ccr_N (proc, r & 0x80 ? 1 : 0);
411 }
412
413 inline void
414 cpu_ccr_update_add16 (sim_cpu *proc, uint16 r, uint16 a, uint16 b)
415 {
416 cpu_set_ccr_C (proc, ((a & b) | (b & ~r) | (a & ~r)) & 0x8000 ? 1 : 0);
417 cpu_set_ccr_V (proc, ((a & b & ~r) | (~a & ~b & r)) & 0x8000 ? 1 : 0);
418 cpu_set_ccr_Z (proc, r == 0);
419 cpu_set_ccr_N (proc, r & 0x8000 ? 1 : 0);
420 }
421
422 inline void
423 cpu_ccr_update_sub16 (sim_cpu *proc, uint16 r, uint16 a, uint16 b)
424 {
425 cpu_set_ccr_C (proc, ((~a & b) | (b & r) | (~a & r)) & 0x8000 ? 1 : 0);
426 cpu_set_ccr_V (proc, ((a & ~b & ~r) | (~a & b & r)) & 0x8000 ? 1 : 0);
427 cpu_set_ccr_Z (proc, r == 0);
428 cpu_set_ccr_N (proc, r & 0x8000 ? 1 : 0);
429 }
430
431 /* Push and pop instructions for 68HC11 (next-available stack mode). */
432 inline void
433 cpu_m68hc11_push_uint8 (sim_cpu *proc, uint8 val)
434 {
435 uint16 addr = proc->cpu_regs.sp;
436
437 memory_write8 (proc, addr, val);
438 proc->cpu_regs.sp = addr - 1;
439 }
440
441 inline void
442 cpu_m68hc11_push_uint16 (sim_cpu *proc, uint16 val)
443 {
444 uint16 addr = proc->cpu_regs.sp - 1;
445
446 memory_write16 (proc, addr, val);
447 proc->cpu_regs.sp = addr - 1;
448 }
449
450 inline uint8
451 cpu_m68hc11_pop_uint8 (sim_cpu *proc)
452 {
453 uint16 addr = proc->cpu_regs.sp;
454 uint8 val;
455
456 val = memory_read8 (proc, addr + 1);
457 proc->cpu_regs.sp = addr + 1;
458 return val;
459 }
460
461 inline uint16
462 cpu_m68hc11_pop_uint16 (sim_cpu *proc)
463 {
464 uint16 addr = proc->cpu_regs.sp;
465 uint16 val;
466
467 val = memory_read16 (proc, addr + 1);
468 proc->cpu_regs.sp = addr + 2;
469 return val;
470 }
471
472 /* Push and pop instructions for 68HC12 (last-used stack mode). */
473 inline void
474 cpu_m68hc12_push_uint8 (sim_cpu *proc, uint8 val)
475 {
476 uint16 addr = proc->cpu_regs.sp;
477
478 addr --;
479 memory_write8 (proc, addr, val);
480 proc->cpu_regs.sp = addr;
481 }
482
483 inline void
484 cpu_m68hc12_push_uint16 (sim_cpu *proc, uint16 val)
485 {
486 uint16 addr = proc->cpu_regs.sp;
487
488 addr -= 2;
489 memory_write16 (proc, addr, val);
490 proc->cpu_regs.sp = addr;
491 }
492
493 inline uint8
494 cpu_m68hc12_pop_uint8 (sim_cpu *proc)
495 {
496 uint16 addr = proc->cpu_regs.sp;
497 uint8 val;
498
499 val = memory_read8 (proc, addr);
500 proc->cpu_regs.sp = addr + 1;
501 return val;
502 }
503
504 inline uint16
505 cpu_m68hc12_pop_uint16 (sim_cpu *proc)
506 {
507 uint16 addr = proc->cpu_regs.sp;
508 uint16 val;
509
510 val = memory_read16 (proc, addr);
511 proc->cpu_regs.sp = addr + 2;
512 return val;
513 }
514
515 /* Fetch a 8/16 bit value and update the PC. */
516 inline uint8
517 cpu_fetch8 (sim_cpu *proc)
518 {
519 uint16 addr = proc->cpu_regs.pc;
520 uint8 val;
521
522 val = memory_read8 (proc, addr);
523 proc->cpu_regs.pc = addr + 1;
524 return val;
525 }
526
527 inline uint16
528 cpu_fetch16 (sim_cpu *proc)
529 {
530 uint16 addr = proc->cpu_regs.pc;
531 uint16 val;
532
533 val = memory_read16 (proc, addr);
534 proc->cpu_regs.pc = addr + 2;
535 return val;
536 }
537
538 extern void cpu_call (sim_cpu* proc, uint16 addr);
539 extern void cpu_exg (sim_cpu* proc, uint8 code);
540 extern void cpu_dbcc (sim_cpu* proc);
541 extern void cpu_special (sim_cpu *proc, enum M6811_Special special);
542 extern void cpu_move8 (sim_cpu *proc, uint8 op);
543 extern void cpu_move16 (sim_cpu *proc, uint8 op);
544
545 extern uint16 cpu_fetch_relbranch (sim_cpu *proc);
546 extern uint16 cpu_fetch_relbranch16 (sim_cpu *proc);
547 extern void cpu_push_all (sim_cpu *proc);
548 extern void cpu_single_step (sim_cpu *proc);
549
550 extern void cpu_info (SIM_DESC sd, sim_cpu *proc);
551
552 extern int cpu_initialize (SIM_DESC sd, sim_cpu *cpu);
553
554 /* Returns the address of a 68HC12 indexed operand.
555 Pre and post modifications are handled on the source register. */
556 extern uint16 cpu_get_indexed_operand_addr (sim_cpu *cpu, int restricted);
557
558 extern void cpu_return (sim_cpu *cpu);
559 extern void cpu_set_sp (sim_cpu *cpu, uint16 val);
560 extern int cpu_reset (sim_cpu *cpu);
561 extern int cpu_restart (sim_cpu *cpu);
562 extern void sim_memory_error (sim_cpu *cpu, SIM_SIGNAL excep,
563 uint16 addr, const char *message, ...);
564 extern void emul_os (int op, sim_cpu *cpu);
565 extern void cpu_interp_m6811 (sim_cpu *cpu);
566 extern void cpu_interp_m6812 (sim_cpu *cpu);
567
568 extern int m68hc11cpu_set_oscillator (SIM_DESC sd, const char *port,
569 double ton, double toff,
570 signed64 repeat);
571 extern int m68hc11cpu_clear_oscillator (SIM_DESC sd, const char *port);
572 extern void m68hc11cpu_set_port (struct hw *me, sim_cpu *cpu,
573 unsigned addr, uint8 val);
574
575 /* The current state of the processor; registers, memory, etc. */
576
577 struct sim_state {
578 sim_cpu *cpu[MAX_NR_PROCESSORS];
579 device *devices;
580 sim_state_base base;
581 };
582
583 extern void sim_board_reset (SIM_DESC sd);
584
585 #define PRINT_TIME 0x01
586 #define PRINT_CYCLE 0x02
587 extern const char *cycle_to_string (sim_cpu *cpu, signed64 t, int flags);
588
589 #endif
590
591
This page took 0.041492 seconds and 5 git commands to generate.