1 /* sim-main.h -- Simulator for Motorola 68HC11 & 68HC12
2 Copyright (C) 1999-2023 Free Software Foundation, Inc.
3 Written by Stephane Carrez (stcarrez@nerim.fr)
5 This file is part of the GNU simulators.
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 #include "sim-basics.h"
26 #include "opcode/m68hc11.h"
29 #include "opcode/m68hc11.h"
30 #include "sim-signal.h"
31 #include "sim-types.h"
33 #include "interrupts.h"
36 /* Specifies the level of mapping for the IO, EEprom, nvram and external
37 RAM. IO registers are mapped over everything and the external RAM
38 is last (ie, it can be hidden by everything above it in the list). */
39 enum m68hc11_map_level
64 typedef struct m6811_regs
{
75 /* Description of 68HC11 IO registers. Such description is only provided
76 for the info command to display the current setting of IO registers
81 const char *short_name
;
82 const char *long_name
;
84 typedef struct io_reg_desc io_reg_desc
;
86 extern void print_io_reg_desc (SIM_DESC sd
, io_reg_desc
*desc
, int val
,
88 extern void print_io_byte (SIM_DESC sd
, const char *name
,
89 io_reg_desc
*desc
, uint8_t val
, uint16_t addr
);
90 extern void print_io_word (SIM_DESC sd
, const char *name
,
91 io_reg_desc
*desc
, uint16_t val
, uint16_t addr
);
94 /* List of special 68HC11&68HC12 instructions that are not handled by the
95 'gencode.c' generator. These complex instructions are implemented
99 /* 68HC11 instructions. */
109 /* 68HC12 instructions. */
128 #define M6811_MAX_PORTS (0x03f+1)
129 #define M6812_MAX_PORTS (0x3ff+1)
130 #define MAX_PORTS (M6812_MAX_PORTS)
132 typedef void (* cpu_interp
) (sim_cpu
*);
134 struct m68hc11_sim_cpu
{
136 struct m6811_regs cpu_regs
;
138 /* CPU interrupts. */
139 struct interrupts cpu_interrupts
;
141 /* Pointer to the interpretor routine. */
142 cpu_interp cpu_interpretor
;
144 /* Pointer to the architecture currently configured in the simulator. */
145 const struct bfd_arch_info
*cpu_configured_arch
;
147 /* CPU absolute cycle time. The cycle time is updated after
148 each instruction, by the number of cycles taken by the instruction.
149 It is cleared only when reset occurs. */
150 int64_t cpu_absolute_cycle
;
152 /* Number of cycles to increment after the current instruction.
153 This is also the number of ticks for the generic event scheduler. */
154 uint8_t cpu_current_cycle
;
155 int cpu_emul_syscall
;
156 int cpu_is_initialized
;
158 int cpu_check_memory
;
159 int cpu_stop_on_interrupt
;
161 /* When this is set, start execution of program at address specified
162 in the ELF header. This is used for testing some programs that do not
163 have an interrupt table linked with them. Programs created during the
164 GCC validation are like this. A normal 68HC11 does not behave like
165 this (unless there is some OS or downloadable feature). */
166 int cpu_use_elf_start
;
168 /* The starting address specified in ELF header. */
171 uint16_t cpu_insn_pc
;
173 /* CPU frequency. This is the quartz frequency. It is divided by 4 to
174 get the cycle time. This is used for the timer rate and for the baud
176 unsigned long cpu_frequency
;
178 /* The mode in which the CPU is configured (MODA and MODB pins). */
179 unsigned int cpu_mode
;
180 const char* cpu_start_mode
;
182 /* The cpu being configured. */
183 enum cpu_type cpu_type
;
185 /* Initial value of the CONFIG register. */
187 uint8_t cpu_use_local_config
;
189 uint8_t ios
[MAX_PORTS
];
191 /* Memory bank parameters which describe how the memory bank window
192 is mapped in memory and how to convert it in virtual address. */
195 address_word bank_virtual
;
201 #define M68HC11_SIM_CPU(cpu) ((struct m68hc11_sim_cpu *) CPU_ARCH_DATA (cpu))
203 /* Returns the cpu absolute cycle time (A virtual counter incremented
204 at each 68HC11 E clock). */
205 #define cpu_current_cycle(cpu) (M68HC11_SIM_CPU (cpu)->cpu_absolute_cycle)
206 #define cpu_add_cycles(cpu, T) (M68HC11_SIM_CPU (cpu)->cpu_current_cycle += (int64_t) (T))
207 #define cpu_is_running(cpu) (M68HC11_SIM_CPU (cpu)->cpu_running)
209 /* Get the IO/RAM base addresses depending on the M6811_INIT register. */
210 #define cpu_get_io_base(cpu) \
211 (((uint16_t)((M68HC11_SIM_CPU (cpu)->ios[M6811_INIT]) & 0x0F)) << 12)
212 #define cpu_get_reg_base(cpu) \
213 (((uint16_t)((M68HC11_SIM_CPU (cpu)->ios[M6811_INIT]) & 0xF0)) << 8)
215 /* Returns the different CPU registers. */
216 #define cpu_get_ccr(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.ccr)
217 #define cpu_get_pc(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.pc)
218 #define cpu_get_d(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.d)
219 #define cpu_get_x(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.ix)
220 #define cpu_get_y(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.iy)
221 #define cpu_get_sp(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.sp)
222 #define cpu_get_a(cpu) ((M68HC11_SIM_CPU (cpu)->cpu_regs.d >> 8) & 0x0FF)
223 #define cpu_get_b(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.d & 0x0FF)
224 #define cpu_get_page(cpu) (M68HC11_SIM_CPU (cpu)->cpu_regs.page)
226 /* 68HC12 specific and Motorola internal registers. */
227 #define cpu_get_tmp3(cpu) (0)
228 #define cpu_get_tmp2(cpu) (0)
230 #define cpu_set_d(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.d = (val))
231 #define cpu_set_x(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.ix = (val))
232 #define cpu_set_y(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.iy = (val))
233 #define cpu_set_page(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.page = (val))
235 /* 68HC12 specific and Motorola internal registers. */
236 #define cpu_set_tmp3(cpu, val) (0)
237 #define cpu_set_tmp2(cpu, val) (void) (0)
240 /* This is a function in m68hc11_sim.c to keep track of the frame. */
241 #define cpu_set_sp(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.sp = (val))
244 #define cpu_set_pc(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.pc = (val))
246 #define cpu_set_a(cpu, val) \
247 cpu_set_d(cpu, ((val) << 8) | cpu_get_b (cpu))
248 #define cpu_set_b(cpu, val) \
249 cpu_set_d(cpu, ((cpu_get_a (cpu)) << 8) | ((val) & 0x0FF))
251 #define cpu_set_ccr(cpu, val) (M68HC11_SIM_CPU (cpu)->cpu_regs.ccr = (val))
252 #define cpu_get_ccr_H(cpu) ((cpu_get_ccr (cpu) & M6811_H_BIT) ? 1 : 0)
253 #define cpu_get_ccr_X(cpu) ((cpu_get_ccr (cpu) & M6811_X_BIT) ? 1 : 0)
254 #define cpu_get_ccr_S(cpu) ((cpu_get_ccr (cpu) & M6811_S_BIT) ? 1 : 0)
255 #define cpu_get_ccr_N(cpu) ((cpu_get_ccr (cpu) & M6811_N_BIT) ? 1 : 0)
256 #define cpu_get_ccr_V(cpu) ((cpu_get_ccr (cpu) & M6811_V_BIT) ? 1 : 0)
257 #define cpu_get_ccr_C(cpu) ((cpu_get_ccr (cpu) & M6811_C_BIT) ? 1 : 0)
258 #define cpu_get_ccr_Z(cpu) ((cpu_get_ccr (cpu) & M6811_Z_BIT) ? 1 : 0)
259 #define cpu_get_ccr_I(cpu) ((cpu_get_ccr (cpu) & M6811_I_BIT) ? 1 : 0)
261 #define cpu_set_ccr_flag(S, B, V) \
262 cpu_set_ccr (S, (cpu_get_ccr (S) & ~(B)) | ((V) ? (B) : 0))
264 #define cpu_set_ccr_H(cpu, val) cpu_set_ccr_flag (cpu, M6811_H_BIT, val)
265 #define cpu_set_ccr_X(cpu, val) cpu_set_ccr_flag (cpu, M6811_X_BIT, val)
266 #define cpu_set_ccr_S(cpu, val) cpu_set_ccr_flag (cpu, M6811_S_BIT, val)
267 #define cpu_set_ccr_N(cpu, val) cpu_set_ccr_flag (cpu, M6811_N_BIT, val)
268 #define cpu_set_ccr_V(cpu, val) cpu_set_ccr_flag (cpu, M6811_V_BIT, val)
269 #define cpu_set_ccr_C(cpu, val) cpu_set_ccr_flag (cpu, M6811_C_BIT, val)
270 #define cpu_set_ccr_Z(cpu, val) cpu_set_ccr_flag (cpu, M6811_Z_BIT, val)
271 #define cpu_set_ccr_I(cpu, val) cpu_set_ccr_flag (cpu, M6811_I_BIT, val)
273 extern void cpu_memory_exception (sim_cpu
*cpu
,
276 const char *message
);
278 STATIC_INLINE UNUSED address_word
279 phys_to_virt (sim_cpu
*cpu
, address_word addr
)
281 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
283 if (addr
>= m68hc11_cpu
->bank_start
&& addr
< m68hc11_cpu
->bank_end
)
284 return ((address_word
) (addr
- m68hc11_cpu
->bank_start
)
285 + (((address_word
) m68hc11_cpu
->cpu_regs
.page
) << m68hc11_cpu
->bank_shift
)
286 + m68hc11_cpu
->bank_virtual
);
288 return (address_word
) (addr
);
291 STATIC_INLINE UNUSED
uint8_t
292 memory_read8 (sim_cpu
*cpu
, uint16_t addr
)
296 if (sim_core_read_buffer (CPU_STATE (cpu
), cpu
, 0, &val
, addr
, 1) != 1)
298 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
304 STATIC_INLINE UNUSED
void
305 memory_write8 (sim_cpu
*cpu
, uint16_t addr
, uint8_t val
)
307 if (sim_core_write_buffer (CPU_STATE (cpu
), cpu
, 0, &val
, addr
, 1) != 1)
309 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
314 STATIC_INLINE UNUSED
uint16_t
315 memory_read16 (sim_cpu
*cpu
, uint16_t addr
)
319 if (sim_core_read_buffer (CPU_STATE (cpu
), cpu
, 0, b
, addr
, 2) != 2)
321 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
324 return (((uint16_t) (b
[0])) << 8) | ((uint16_t) b
[1]);
327 STATIC_INLINE UNUSED
void
328 memory_write16 (sim_cpu
*cpu
, uint16_t addr
, uint16_t val
)
334 if (sim_core_write_buffer (CPU_STATE (cpu
), cpu
, 0, b
, addr
, 2) != 2)
336 cpu_memory_exception (cpu
, SIM_SIGSEGV
, addr
,
341 cpu_ccr_update_tst8 (sim_cpu
*cpu
, uint8_t val
);
343 STATIC_INLINE UNUSED
void
344 cpu_ccr_update_tst16 (sim_cpu
*cpu
, uint16_t val
)
346 cpu_set_ccr_V (cpu
, 0);
347 cpu_set_ccr_N (cpu
, val
& 0x8000 ? 1 : 0);
348 cpu_set_ccr_Z (cpu
, val
== 0 ? 1 : 0);
351 STATIC_INLINE UNUSED
void
352 cpu_ccr_update_shift8 (sim_cpu
*cpu
, uint8_t val
)
354 cpu_set_ccr_N (cpu
, val
& 0x80 ? 1 : 0);
355 cpu_set_ccr_Z (cpu
, val
== 0 ? 1 : 0);
356 cpu_set_ccr_V (cpu
, cpu_get_ccr_N (cpu
) ^ cpu_get_ccr_C (cpu
));
359 STATIC_INLINE UNUSED
void
360 cpu_ccr_update_shift16 (sim_cpu
*cpu
, uint16_t val
)
362 cpu_set_ccr_N (cpu
, val
& 0x8000 ? 1 : 0);
363 cpu_set_ccr_Z (cpu
, val
== 0 ? 1 : 0);
364 cpu_set_ccr_V (cpu
, cpu_get_ccr_N (cpu
) ^ cpu_get_ccr_C (cpu
));
367 STATIC_INLINE UNUSED
void
368 cpu_ccr_update_add8 (sim_cpu
*cpu
, uint8_t r
, uint8_t a
, uint8_t b
)
370 cpu_set_ccr_C (cpu
, ((a
& b
) | (b
& ~r
) | (a
& ~r
)) & 0x80 ? 1 : 0);
371 cpu_set_ccr_V (cpu
, ((a
& b
& ~r
) | (~a
& ~b
& r
)) & 0x80 ? 1 : 0);
372 cpu_set_ccr_Z (cpu
, r
== 0);
373 cpu_set_ccr_N (cpu
, r
& 0x80 ? 1 : 0);
377 STATIC_INLINE UNUSED
void
378 cpu_ccr_update_sub8 (sim_cpu
*cpu
, uint8_t r
, uint8_t a
, uint8_t b
)
380 cpu_set_ccr_C (cpu
, ((~a
& b
) | (b
& r
) | (~a
& r
)) & 0x80 ? 1 : 0);
381 cpu_set_ccr_V (cpu
, ((a
& ~b
& ~r
) | (~a
& b
& r
)) & 0x80 ? 1 : 0);
382 cpu_set_ccr_Z (cpu
, r
== 0);
383 cpu_set_ccr_N (cpu
, r
& 0x80 ? 1 : 0);
386 STATIC_INLINE UNUSED
void
387 cpu_ccr_update_add16 (sim_cpu
*cpu
, uint16_t r
, uint16_t a
, uint16_t b
)
389 cpu_set_ccr_C (cpu
, ((a
& b
) | (b
& ~r
) | (a
& ~r
)) & 0x8000 ? 1 : 0);
390 cpu_set_ccr_V (cpu
, ((a
& b
& ~r
) | (~a
& ~b
& r
)) & 0x8000 ? 1 : 0);
391 cpu_set_ccr_Z (cpu
, r
== 0);
392 cpu_set_ccr_N (cpu
, r
& 0x8000 ? 1 : 0);
395 STATIC_INLINE UNUSED
void
396 cpu_ccr_update_sub16 (sim_cpu
*cpu
, uint16_t r
, uint16_t a
, uint16_t b
)
398 cpu_set_ccr_C (cpu
, ((~a
& b
) | (b
& r
) | (~a
& r
)) & 0x8000 ? 1 : 0);
399 cpu_set_ccr_V (cpu
, ((a
& ~b
& ~r
) | (~a
& b
& r
)) & 0x8000 ? 1 : 0);
400 cpu_set_ccr_Z (cpu
, r
== 0);
401 cpu_set_ccr_N (cpu
, r
& 0x8000 ? 1 : 0);
404 /* Push and pop instructions for 68HC11 (next-available stack mode). */
405 STATIC_INLINE UNUSED
void
406 cpu_m68hc11_push_uint8 (sim_cpu
*cpu
, uint8_t val
)
408 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
409 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
411 memory_write8 (cpu
, addr
, val
);
412 m68hc11_cpu
->cpu_regs
.sp
= addr
- 1;
415 STATIC_INLINE UNUSED
void
416 cpu_m68hc11_push_uint16 (sim_cpu
*cpu
, uint16_t val
)
418 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
419 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
- 1;
421 memory_write16 (cpu
, addr
, val
);
422 m68hc11_cpu
->cpu_regs
.sp
= addr
- 1;
425 STATIC_INLINE UNUSED
uint8_t
426 cpu_m68hc11_pop_uint8 (sim_cpu
*cpu
)
428 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
429 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
432 val
= memory_read8 (cpu
, addr
+ 1);
433 m68hc11_cpu
->cpu_regs
.sp
= addr
+ 1;
437 STATIC_INLINE UNUSED
uint16_t
438 cpu_m68hc11_pop_uint16 (sim_cpu
*cpu
)
440 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
441 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
444 val
= memory_read16 (cpu
, addr
+ 1);
445 m68hc11_cpu
->cpu_regs
.sp
= addr
+ 2;
449 /* Push and pop instructions for 68HC12 (last-used stack mode). */
450 STATIC_INLINE UNUSED
void
451 cpu_m68hc12_push_uint8 (sim_cpu
*cpu
, uint8_t val
)
453 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
454 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
457 memory_write8 (cpu
, addr
, val
);
458 m68hc11_cpu
->cpu_regs
.sp
= addr
;
461 STATIC_INLINE UNUSED
void
462 cpu_m68hc12_push_uint16 (sim_cpu
*cpu
, uint16_t val
)
464 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
465 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
468 memory_write16 (cpu
, addr
, val
);
469 m68hc11_cpu
->cpu_regs
.sp
= addr
;
472 STATIC_INLINE UNUSED
uint8_t
473 cpu_m68hc12_pop_uint8 (sim_cpu
*cpu
)
475 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
476 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
479 val
= memory_read8 (cpu
, addr
);
480 m68hc11_cpu
->cpu_regs
.sp
= addr
+ 1;
484 STATIC_INLINE UNUSED
uint16_t
485 cpu_m68hc12_pop_uint16 (sim_cpu
*cpu
)
487 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
488 uint16_t addr
= m68hc11_cpu
->cpu_regs
.sp
;
491 val
= memory_read16 (cpu
, addr
);
492 m68hc11_cpu
->cpu_regs
.sp
= addr
+ 2;
496 /* Fetch a 8/16 bit value and update the PC. */
497 STATIC_INLINE UNUSED
uint8_t
498 cpu_fetch8 (sim_cpu
*cpu
)
500 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
501 uint16_t addr
= m68hc11_cpu
->cpu_regs
.pc
;
504 val
= memory_read8 (cpu
, addr
);
505 m68hc11_cpu
->cpu_regs
.pc
= addr
+ 1;
509 STATIC_INLINE UNUSED
uint16_t
510 cpu_fetch16 (sim_cpu
*cpu
)
512 struct m68hc11_sim_cpu
*m68hc11_cpu
= M68HC11_SIM_CPU (cpu
);
513 uint16_t addr
= m68hc11_cpu
->cpu_regs
.pc
;
516 val
= memory_read16 (cpu
, addr
);
517 m68hc11_cpu
->cpu_regs
.pc
= addr
+ 2;
521 extern void cpu_call (sim_cpu
*cpu
, uint16_t addr
);
522 extern void cpu_exg (sim_cpu
*cpu
, uint8_t code
);
523 extern void cpu_dbcc (sim_cpu
*cpu
);
524 extern void cpu_special (sim_cpu
*cpu
, enum M6811_Special special
);
525 extern void cpu_move8 (sim_cpu
*cpu
, uint8_t op
);
526 extern void cpu_move16 (sim_cpu
*cpu
, uint8_t op
);
528 extern uint16_t cpu_fetch_relbranch (sim_cpu
*cpu
);
529 extern uint16_t cpu_fetch_relbranch16 (sim_cpu
*cpu
);
530 extern void cpu_push_all (sim_cpu
*cpu
);
531 extern void cpu_single_step (sim_cpu
*cpu
);
533 extern void cpu_info (SIM_DESC sd
, sim_cpu
*cpu
);
535 extern int cpu_initialize (SIM_DESC sd
, sim_cpu
*cpu
);
537 /* Returns the address of a 68HC12 indexed operand.
538 Pre and post modifications are handled on the source register. */
539 extern uint16_t cpu_get_indexed_operand_addr (sim_cpu
*cpu
, int restricted
);
541 extern void cpu_return (sim_cpu
*cpu
);
542 extern void cpu_set_sp (sim_cpu
*cpu
, uint16_t val
);
543 extern int cpu_reset (sim_cpu
*cpu
);
544 extern int cpu_restart (sim_cpu
*cpu
);
545 extern void sim_memory_error (sim_cpu
*cpu
, SIM_SIGNAL excep
,
546 uint16_t addr
, const char *message
, ...)
547 ATTRIBUTE_PRINTF (4, 5);
548 extern void emul_os (int op
, sim_cpu
*cpu
);
549 extern void cpu_interp_m6811 (sim_cpu
*cpu
);
550 extern void cpu_interp_m6812 (sim_cpu
*cpu
);
552 extern int m68hc11cpu_set_oscillator (SIM_DESC sd
, const char *port
,
553 double ton
, double toff
,
555 extern int m68hc11cpu_clear_oscillator (SIM_DESC sd
, const char *port
);
556 extern void m68hc11cpu_set_port (struct hw
*me
, sim_cpu
*cpu
,
557 unsigned addr
, uint8_t val
);
559 extern void sim_board_reset (SIM_DESC sd
);
561 #define PRINT_TIME 0x01
562 #define PRINT_CYCLE 0x02
563 extern const char *cycle_to_string (sim_cpu
*cpu
, int64_t t
, int flags
);