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)
5 This file is part of GDB, the GNU debugger.
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.
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.
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/>. */
23 #define WITH_WATCHPOINTS 1
24 #define SIM_HANDLES_LMA 1
26 #include "sim-basics.h"
27 #include "sim-signal.h"
32 #include "opcode/m68hc11.h"
34 #include "gdb/callback.h"
35 #include "gdb/remote-sim.h"
36 #include "opcode/m68hc11.h"
37 #include "sim-types.h"
39 typedef unsigned8 uint8
;
40 typedef unsigned16 uint16
;
41 typedef signed16 int16
;
42 typedef unsigned32 uint32
;
43 typedef signed32 int32
;
44 typedef unsigned64 uint64
;
45 typedef signed64 int64
;
49 #include "interrupts.h"
52 /* Specifies the level of mapping for the IO, EEprom, nvram and external
53 RAM. IO registers are mapped over everything and the external RAM
54 is last (ie, it can be hidden by everything above it in the list). */
55 enum m68hc11_map_level
80 typedef struct m6811_regs
{
91 /* Description of 68HC11 IO registers. Such description is only provided
92 for the info command to display the current setting of IO registers
97 const char *short_name
;
98 const char *long_name
;
100 typedef struct io_reg_desc io_reg_desc
;
102 extern void print_io_reg_desc (SIM_DESC sd
, io_reg_desc
*desc
, int val
,
104 extern void print_io_byte (SIM_DESC sd
, const char *name
,
105 io_reg_desc
*desc
, uint8 val
, uint16 addr
);
106 extern void print_io_word (SIM_DESC sd
, const char *name
,
107 io_reg_desc
*desc
, uint16 val
, uint16 addr
);
110 /* List of special 68HC11&68HC12 instructions that are not handled by the
111 'gencode.c' generator. These complex instructions are implemented
115 /* 68HC11 instructions. */
125 /* 68HC12 instructions. */
144 #define M6811_MAX_PORTS (0x03f+1)
145 #define M6812_MAX_PORTS (0x3ff+1)
146 #define MAX_PORTS (M6812_MAX_PORTS)
150 typedef void (* cpu_interp
) (struct _sim_cpu
*);
154 struct m6811_regs cpu_regs
;
156 /* CPU interrupts. */
157 struct interrupts cpu_interrupts
;
159 /* Pointer to the interpretor routine. */
160 cpu_interp cpu_interpretor
;
162 /* Pointer to the architecture currently configured in the simulator. */
163 const struct bfd_arch_info
*cpu_configured_arch
;
165 /* CPU absolute cycle time. The cycle time is updated after
166 each instruction, by the number of cycles taken by the instruction.
167 It is cleared only when reset occurs. */
168 signed64 cpu_absolute_cycle
;
170 /* Number of cycles to increment after the current instruction.
171 This is also the number of ticks for the generic event scheduler. */
172 uint8 cpu_current_cycle
;
173 int cpu_emul_syscall
;
174 int cpu_is_initialized
;
176 int cpu_check_memory
;
177 int cpu_stop_on_interrupt
;
179 /* When this is set, start execution of program at address specified
180 in the ELF header. This is used for testing some programs that do not
181 have an interrupt table linked with them. Programs created during the
182 GCC validation are like this. A normal 68HC11 does not behave like
183 this (unless there is some OS or downloadable feature). */
184 int cpu_use_elf_start
;
186 /* The starting address specified in ELF header. */
191 /* CPU frequency. This is the quartz frequency. It is divided by 4 to
192 get the cycle time. This is used for the timer rate and for the baud
194 unsigned long cpu_frequency
;
196 /* The mode in which the CPU is configured (MODA and MODB pins). */
197 unsigned int cpu_mode
;
198 const char* cpu_start_mode
;
200 /* The cpu being configured. */
201 enum cpu_type cpu_type
;
203 /* Initial value of the CONFIG register. */
205 uint8 cpu_use_local_config
;
207 uint8 ios
[MAX_PORTS
];
209 /* Memory bank parameters which describe how the memory bank window
210 is mapped in memory and how to convert it in virtual address. */
213 address_word bank_virtual
;
219 /* ... base type ... */
223 /* Returns the cpu absolute cycle time (A virtual counter incremented
224 at each 68HC11 E clock). */
225 #define cpu_current_cycle(PROC) ((PROC)->cpu_absolute_cycle)
226 #define cpu_add_cycles(PROC,T) ((PROC)->cpu_current_cycle += (signed64) (T))
227 #define cpu_is_running(PROC) ((PROC)->cpu_running)
229 /* Get the IO/RAM base addresses depending on the M6811_INIT register. */
230 #define cpu_get_io_base(PROC) \
231 (((uint16)(((PROC)->ios[M6811_INIT]) & 0x0F))<<12)
232 #define cpu_get_reg_base(PROC) \
233 (((uint16)(((PROC)->ios[M6811_INIT]) & 0xF0))<<8)
235 /* Returns the different CPU registers. */
236 #define cpu_get_ccr(PROC) ((PROC)->cpu_regs.ccr)
237 #define cpu_get_pc(PROC) ((PROC)->cpu_regs.pc)
238 #define cpu_get_d(PROC) ((PROC)->cpu_regs.d)
239 #define cpu_get_x(PROC) ((PROC)->cpu_regs.ix)
240 #define cpu_get_y(PROC) ((PROC)->cpu_regs.iy)
241 #define cpu_get_sp(PROC) ((PROC)->cpu_regs.sp)
242 #define cpu_get_a(PROC) ((PROC->cpu_regs.d >> 8) & 0x0FF)
243 #define cpu_get_b(PROC) ((PROC->cpu_regs.d) & 0x0FF)
244 #define cpu_get_page(PROC) ((PROC)->cpu_regs.page)
246 /* 68HC12 specific and Motorola internal registers. */
247 #define cpu_get_tmp3(PROC) (0)
248 #define cpu_get_tmp2(PROC) (0)
250 #define cpu_set_d(PROC,VAL) (((PROC)->cpu_regs.d) = (VAL))
251 #define cpu_set_x(PROC,VAL) (((PROC)->cpu_regs.ix) = (VAL))
252 #define cpu_set_y(PROC,VAL) (((PROC)->cpu_regs.iy) = (VAL))
253 #define cpu_set_page(PROC,VAL) (((PROC)->cpu_regs.page) = (VAL))
255 /* 68HC12 specific and Motorola internal registers. */
256 #define cpu_set_tmp3(PROC,VAL) (0)
257 #define cpu_set_tmp2(PROC,VAL) (void) (0)
260 /* This is a function in m68hc11_sim.c to keep track of the frame. */
261 #define cpu_set_sp(PROC,VAL) (((PROC)->cpu_regs.sp) = (VAL))
264 #define cpu_set_pc(PROC,VAL) (((PROC)->cpu_regs.pc) = (VAL))
266 #define cpu_set_a(PROC,VAL) \
267 cpu_set_d(PROC,((VAL) << 8) | cpu_get_b(PROC))
268 #define cpu_set_b(PROC,VAL) \
269 cpu_set_d(PROC,((cpu_get_a(PROC)) << 8)|(VAL & 0x0FF))
271 #define cpu_set_ccr(PROC,VAL) ((PROC)->cpu_regs.ccr = (VAL))
272 #define cpu_get_ccr_H(PROC) ((cpu_get_ccr(PROC) & M6811_H_BIT) ? 1: 0)
273 #define cpu_get_ccr_X(PROC) ((cpu_get_ccr(PROC) & M6811_X_BIT) ? 1: 0)
274 #define cpu_get_ccr_S(PROC) ((cpu_get_ccr(PROC) & M6811_S_BIT) ? 1: 0)
275 #define cpu_get_ccr_N(PROC) ((cpu_get_ccr(PROC) & M6811_N_BIT) ? 1: 0)
276 #define cpu_get_ccr_V(PROC) ((cpu_get_ccr(PROC) & M6811_V_BIT) ? 1: 0)
277 #define cpu_get_ccr_C(PROC) ((cpu_get_ccr(PROC) & M6811_C_BIT) ? 1: 0)
278 #define cpu_get_ccr_Z(PROC) ((cpu_get_ccr(PROC) & M6811_Z_BIT) ? 1: 0)
279 #define cpu_get_ccr_I(PROC) ((cpu_get_ccr(PROC) & M6811_I_BIT) ? 1: 0)
281 #define cpu_set_ccr_flag(S,B,V) \
282 cpu_set_ccr(S,(cpu_get_ccr(S) & ~(B)) | ((V) ? B : 0))
284 #define cpu_set_ccr_H(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_H_BIT, VAL)
285 #define cpu_set_ccr_X(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_X_BIT, VAL)
286 #define cpu_set_ccr_S(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_S_BIT, VAL)
287 #define cpu_set_ccr_N(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_N_BIT, VAL)
288 #define cpu_set_ccr_V(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_V_BIT, VAL)
289 #define cpu_set_ccr_C(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_C_BIT, VAL)
290 #define cpu_set_ccr_Z(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_Z_BIT, VAL)
291 #define cpu_set_ccr_I(PROC,VAL) cpu_set_ccr_flag(PROC, M6811_I_BIT, VAL)
294 #define inline static __inline__
296 extern void cpu_memory_exception (struct _sim_cpu
*proc
,
299 const char *message
);
302 phys_to_virt (sim_cpu
*cpu
, address_word addr
)
304 if (addr
>= cpu
->bank_start
&& addr
< cpu
->bank_end
)
305 return ((address_word
) (addr
- cpu
->bank_start
)
306 + (((address_word
) cpu
->cpu_regs
.page
) << cpu
->bank_shift
)
307 + cpu
->bank_virtual
);
309 return (address_word
) (addr
);
313 memory_read8 (sim_cpu
*cpu
, uint16 addr
)
317 if (sim_core_read_buffer (CPU_STATE (cpu
), cpu
, 0, &val
, addr
, 1) != 1)
319 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
326 memory_write8 (sim_cpu
*cpu
, uint16 addr
, uint8 val
)
328 if (sim_core_write_buffer (CPU_STATE (cpu
), cpu
, 0, &val
, addr
, 1) != 1)
330 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
336 memory_read16 (sim_cpu
*cpu
, uint16 addr
)
340 if (sim_core_read_buffer (CPU_STATE (cpu
), cpu
, 0, b
, addr
, 2) != 2)
342 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
345 return (((uint16
) (b
[0])) << 8) | ((uint16
) b
[1]);
349 memory_write16 (sim_cpu
*cpu
, uint16 addr
, uint16 val
)
355 if (sim_core_write_buffer (CPU_STATE (cpu
), cpu
, 0, b
, addr
, 2) != 2)
357 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
362 cpu_ccr_update_tst8 (sim_cpu
*proc
, uint8 val
);
365 cpu_ccr_update_tst16 (sim_cpu
*proc
, uint16 val
)
367 cpu_set_ccr_V (proc
, 0);
368 cpu_set_ccr_N (proc
, val
& 0x8000 ? 1 : 0);
369 cpu_set_ccr_Z (proc
, val
== 0 ? 1 : 0);
373 cpu_ccr_update_shift8 (sim_cpu
*proc
, uint8 val
)
375 cpu_set_ccr_N (proc
, val
& 0x80 ? 1 : 0);
376 cpu_set_ccr_Z (proc
, val
== 0 ? 1 : 0);
377 cpu_set_ccr_V (proc
, cpu_get_ccr_N (proc
) ^ cpu_get_ccr_C (proc
));
381 cpu_ccr_update_shift16 (sim_cpu
*proc
, uint16 val
)
383 cpu_set_ccr_N (proc
, val
& 0x8000 ? 1 : 0);
384 cpu_set_ccr_Z (proc
, val
== 0 ? 1 : 0);
385 cpu_set_ccr_V (proc
, cpu_get_ccr_N (proc
) ^ cpu_get_ccr_C (proc
));
389 cpu_ccr_update_add8 (sim_cpu
*proc
, uint8 r
, uint8 a
, uint8 b
)
391 cpu_set_ccr_C (proc
, ((a
& b
) | (b
& ~r
) | (a
& ~r
)) & 0x80 ? 1 : 0);
392 cpu_set_ccr_V (proc
, ((a
& b
& ~r
) | (~a
& ~b
& r
)) & 0x80 ? 1 : 0);
393 cpu_set_ccr_Z (proc
, r
== 0);
394 cpu_set_ccr_N (proc
, r
& 0x80 ? 1 : 0);
399 cpu_ccr_update_sub8 (sim_cpu
*proc
, uint8 r
, uint8 a
, uint8 b
)
401 cpu_set_ccr_C (proc
, ((~a
& b
) | (b
& r
) | (~a
& r
)) & 0x80 ? 1 : 0);
402 cpu_set_ccr_V (proc
, ((a
& ~b
& ~r
) | (~a
& b
& r
)) & 0x80 ? 1 : 0);
403 cpu_set_ccr_Z (proc
, r
== 0);
404 cpu_set_ccr_N (proc
, r
& 0x80 ? 1 : 0);
408 cpu_ccr_update_add16 (sim_cpu
*proc
, uint16 r
, uint16 a
, uint16 b
)
410 cpu_set_ccr_C (proc
, ((a
& b
) | (b
& ~r
) | (a
& ~r
)) & 0x8000 ? 1 : 0);
411 cpu_set_ccr_V (proc
, ((a
& b
& ~r
) | (~a
& ~b
& r
)) & 0x8000 ? 1 : 0);
412 cpu_set_ccr_Z (proc
, r
== 0);
413 cpu_set_ccr_N (proc
, r
& 0x8000 ? 1 : 0);
417 cpu_ccr_update_sub16 (sim_cpu
*proc
, uint16 r
, uint16 a
, uint16 b
)
419 cpu_set_ccr_C (proc
, ((~a
& b
) | (b
& r
) | (~a
& r
)) & 0x8000 ? 1 : 0);
420 cpu_set_ccr_V (proc
, ((a
& ~b
& ~r
) | (~a
& b
& r
)) & 0x8000 ? 1 : 0);
421 cpu_set_ccr_Z (proc
, r
== 0);
422 cpu_set_ccr_N (proc
, r
& 0x8000 ? 1 : 0);
425 /* Push and pop instructions for 68HC11 (next-available stack mode). */
427 cpu_m68hc11_push_uint8 (sim_cpu
*proc
, uint8 val
)
429 uint16 addr
= proc
->cpu_regs
.sp
;
431 memory_write8 (proc
, addr
, val
);
432 proc
->cpu_regs
.sp
= addr
- 1;
436 cpu_m68hc11_push_uint16 (sim_cpu
*proc
, uint16 val
)
438 uint16 addr
= proc
->cpu_regs
.sp
- 1;
440 memory_write16 (proc
, addr
, val
);
441 proc
->cpu_regs
.sp
= addr
- 1;
445 cpu_m68hc11_pop_uint8 (sim_cpu
*proc
)
447 uint16 addr
= proc
->cpu_regs
.sp
;
450 val
= memory_read8 (proc
, addr
+ 1);
451 proc
->cpu_regs
.sp
= addr
+ 1;
456 cpu_m68hc11_pop_uint16 (sim_cpu
*proc
)
458 uint16 addr
= proc
->cpu_regs
.sp
;
461 val
= memory_read16 (proc
, addr
+ 1);
462 proc
->cpu_regs
.sp
= addr
+ 2;
466 /* Push and pop instructions for 68HC12 (last-used stack mode). */
468 cpu_m68hc12_push_uint8 (sim_cpu
*proc
, uint8 val
)
470 uint16 addr
= proc
->cpu_regs
.sp
;
473 memory_write8 (proc
, addr
, val
);
474 proc
->cpu_regs
.sp
= addr
;
478 cpu_m68hc12_push_uint16 (sim_cpu
*proc
, uint16 val
)
480 uint16 addr
= proc
->cpu_regs
.sp
;
483 memory_write16 (proc
, addr
, val
);
484 proc
->cpu_regs
.sp
= addr
;
488 cpu_m68hc12_pop_uint8 (sim_cpu
*proc
)
490 uint16 addr
= proc
->cpu_regs
.sp
;
493 val
= memory_read8 (proc
, addr
);
494 proc
->cpu_regs
.sp
= addr
+ 1;
499 cpu_m68hc12_pop_uint16 (sim_cpu
*proc
)
501 uint16 addr
= proc
->cpu_regs
.sp
;
504 val
= memory_read16 (proc
, addr
);
505 proc
->cpu_regs
.sp
= addr
+ 2;
509 /* Fetch a 8/16 bit value and update the PC. */
511 cpu_fetch8 (sim_cpu
*proc
)
513 uint16 addr
= proc
->cpu_regs
.pc
;
516 val
= memory_read8 (proc
, addr
);
517 proc
->cpu_regs
.pc
= addr
+ 1;
522 cpu_fetch16 (sim_cpu
*proc
)
524 uint16 addr
= proc
->cpu_regs
.pc
;
527 val
= memory_read16 (proc
, addr
);
528 proc
->cpu_regs
.pc
= addr
+ 2;
532 extern void cpu_call (sim_cpu
* proc
, uint16 addr
);
533 extern void cpu_exg (sim_cpu
* proc
, uint8 code
);
534 extern void cpu_dbcc (sim_cpu
* proc
);
535 extern void cpu_special (sim_cpu
*proc
, enum M6811_Special special
);
536 extern void cpu_move8 (sim_cpu
*proc
, uint8 op
);
537 extern void cpu_move16 (sim_cpu
*proc
, uint8 op
);
539 extern uint16
cpu_fetch_relbranch (sim_cpu
*proc
);
540 extern uint16
cpu_fetch_relbranch16 (sim_cpu
*proc
);
541 extern void cpu_push_all (sim_cpu
*proc
);
542 extern void cpu_single_step (sim_cpu
*proc
);
544 extern void cpu_info (SIM_DESC sd
, sim_cpu
*proc
);
546 extern int cpu_initialize (SIM_DESC sd
, sim_cpu
*cpu
);
548 /* Returns the address of a 68HC12 indexed operand.
549 Pre and post modifications are handled on the source register. */
550 extern uint16
cpu_get_indexed_operand_addr (sim_cpu
*cpu
, int restricted
);
552 extern void cpu_return (sim_cpu
*cpu
);
553 extern void cpu_set_sp (sim_cpu
*cpu
, uint16 val
);
554 extern int cpu_reset (sim_cpu
*cpu
);
555 extern int cpu_restart (sim_cpu
*cpu
);
556 extern void sim_memory_error (sim_cpu
*cpu
, SIM_SIGNAL excep
,
557 uint16 addr
, const char *message
, ...);
558 extern void emul_os (int op
, sim_cpu
*cpu
);
559 extern void cpu_interp_m6811 (sim_cpu
*cpu
);
560 extern void cpu_interp_m6812 (sim_cpu
*cpu
);
562 extern int m68hc11cpu_set_oscillator (SIM_DESC sd
, const char *port
,
563 double ton
, double toff
,
565 extern int m68hc11cpu_clear_oscillator (SIM_DESC sd
, const char *port
);
566 extern void m68hc11cpu_set_port (struct hw
*me
, sim_cpu
*cpu
,
567 unsigned addr
, uint8 val
);
569 /* The current state of the processor; registers, memory, etc. */
572 sim_cpu
*cpu
[MAX_NR_PROCESSORS
];
577 extern void sim_board_reset (SIM_DESC sd
);
579 #define PRINT_TIME 0x01
580 #define PRINT_CYCLE 0x02
581 extern const char *cycle_to_string (sim_cpu
*cpu
, signed64 t
, int flags
);