src/cpus/cpu_m68k.c

/*
 *  Copyright (C) 2005-2006  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_m68k.c,v 1.12 2006/07/20 21:52:59 debug Exp $
 *
 *  Motorola 68K CPU emulation.
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>

#include "cpu.h"
#include "machine.h"
#include "memory.h"
#include "misc.h"
#include "symbol.h"


#define DYNTRANS_32
#define DYNTRANS_VARIABLE_INSTRUCTION_LENGTH
#include "tmp_m68k_head.c"


static char *m68k_aname[] = { "a0", "a1", "a2", "a3", "a4", "a5", "fp", "a7" };


/*
 *  m68k_cpu_new():
 *
 *  Create a new M68K cpu object.
 *
 *  Returns 1 on success, 0 if there was no matching M68K processor with
 *  this cpu_type_name.
 */
int m68k_cpu_new(struct cpu *cpu, struct memory *mem, struct machine *machine,
        int cpu_id, char *cpu_type_name)
{
        if (strcasecmp(cpu_type_name, "68020") != 0)
                return 0;

        cpu->run_instr = m68k_run_instr;
        cpu->memory_rw = m68k_memory_rw;
        cpu->update_translation_table = m68k_update_translation_table;
        cpu->invalidate_translation_caches =
            m68k_invalidate_translation_caches;
        cpu->invalidate_code_translation = m68k_invalidate_code_translation;
        cpu->is_32bit = 1;

        cpu->byte_order = EMUL_BIG_ENDIAN;

        /*  Only show name and caches etc for CPU nr 0 (in SMP machines):  */
        if (cpu_id == 0) {
                debug("%s", cpu->name);
        }

        return 1;
}


/*
 *  m68k_cpu_list_available_types():
 *
 *  Print a list of available M68K CPU types.
 */
void m68k_cpu_list_available_types(void)
{
        debug("68020\n");
        /*  TODO  */
}


/*
 *  m68k_cpu_dumpinfo():
 */
void m68k_cpu_dumpinfo(struct cpu *cpu)
{
        /*  TODO  */
        debug("\n");
}


/*
 *  m68k_cpu_register_dump():
 *
 *  Dump cpu registers in a relatively readable format.
 *
 *  gprs: set to non-zero to dump GPRs and some special-purpose registers.
 *  coprocs: set bit 0..3 to dump registers in coproc 0..3.
 */
void m68k_cpu_register_dump(struct cpu *cpu, int gprs, int coprocs)
{
        char *symbol;
        uint64_t offset;
        int x = cpu->cpu_id;

        if (gprs) {
                /*  Special registers (pc, ...) first:  */
                symbol = get_symbol_name(&cpu->machine->symbol_context,
                    cpu->pc, &offset);

                debug("cpu%i: pc  = 0x%08"PRIx32, x, (uint32_t)cpu->pc);
                debug("  <%s>\n", symbol != NULL? symbol : " no symbol ");
        }
}


/*
 *  m68k_cpu_register_match():
 */
void m68k_cpu_register_match(struct machine *m, char *name,
        int writeflag, uint64_t *valuep, int *match_register)
{
        int cpunr = 0;

        /*  CPU number:  */

        /*  TODO  */

        /*  Register name:  */
        if (strcasecmp(name, "pc") == 0) {
                if (writeflag) {
                        m->cpus[cpunr]->pc = *valuep;
                } else
                        *valuep = m->cpus[cpunr]->pc;
                *match_register = 1;
        }
}


/*
 *  m68k_cpu_tlbdump():
 *
 *  Called from the debugger to dump the TLB in a readable format.
 *  x is the cpu number to dump, or -1 to dump all CPUs.
 *
 *  If rawflag is nonzero, then the TLB contents isn't formated nicely,
 *  just dumped.
 */
void m68k_cpu_tlbdump(struct machine *m, int x, int rawflag)
{
}


/*
 *  m68k_cpu_gdb_stub():
 *
 *  Execute a "remote GDB" command. Returns a newly allocated response string
 *  on success, NULL on failure.
 */
char *m68k_cpu_gdb_stub(struct cpu *cpu, char *cmd)
{
        fatal("m68k_cpu_gdb_stub(): TODO\n");
        return NULL;
}


/*
 *  m68k_cpu_interrupt():
 */
int m68k_cpu_interrupt(struct cpu *cpu, uint64_t irq_nr)
{
        fatal("m68k_cpu_interrupt(): TODO\n");
        return 0;
}


/*
 *  m68k_cpu_interrupt_ack():
 */
int m68k_cpu_interrupt_ack(struct cpu *cpu, uint64_t irq_nr)
{
        /*  fatal("m68k_cpu_interrupt_ack(): TODO\n");  */
        return 0;
}


/*  Helper functions:  */
static void print_two(unsigned char *instr, int *len)
{ debug(" %02x%02x", instr[*len], instr[*len+1]); (*len) += 2; }
static void print_spaces(int len) { int i; debug(" "); for (i=0; i<16-len/2*5;
    i++) debug(" "); }


/*
 *  m68k_cpu_disassemble_instr():
 *
 *  Convert an instruction word into human readable format, for instruction
 *  tracing.
 *
 *  If running is 1, cpu->pc should be the address of the instruction.
 *
 *  If running is 0, things that depend on the runtime environment (eg.
 *  register contents) will not be shown, and addr will be used instead of
 *  cpu->pc for relative addresses.
 */
int m68k_cpu_disassemble_instr(struct cpu *cpu, unsigned char *ib,
        int running, uint64_t dumpaddr)
{
        uint64_t offset;
        int len = 0;
        char *symbol;

        if (running)
                dumpaddr = cpu->pc;

        symbol = get_symbol_name(&cpu->machine->symbol_context,
            dumpaddr, &offset);
        if (symbol != NULL && offset==0)
                debug("<%s>\n", symbol);

        if (cpu->machine->ncpus > 1 && running)
                debug("cpu%i: ", cpu->cpu_id);

        debug("0x%08x: ", (int)dumpaddr);

        print_two(ib, &len);

        if (ib[0] == 0x48) {
                if (ib[1] >= 0x40 && ib[1] <= 0x47) {
                        print_spaces(len);
                        debug("swap\td%i\n", ib[1] & 7);
                } else if (ib[1] >= 0x48 && ib[1] <= 0x4f) {
                        print_spaces(len);
                        debug("bkpt\t#%i\n", ib[1] & 7);
                } else {
                        print_spaces(len);
                        debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
                }
        } else if (ib[0] == 0x4a) {
                if (ib[1] == 0xfc) {
                        print_spaces(len);
                        debug("illegal\n");
                } else {
                        print_spaces(len);
                        debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
                }
        } else if (ib[0] == 0x4e) {
                if (ib[1] >= 0x40 && ib[1] <= 0x4f) {
                        print_spaces(len);
                        debug("trap\t#%i\n", ib[1] & 15);
                } else if (ib[1] >= 0x50 && ib[1] <= 0x57) {
                        print_two(ib, &len);
                        print_spaces(len);
                        debug("linkw\t%%%s,#%i\n", m68k_aname[ib[1] & 7],
                            ((ib[2] << 8) + ib[3]));
                } else if (ib[1] >= 0x58 && ib[1] <= 0x5f) {
                        print_spaces(len);
                        debug("unlk\t%%%s\n", m68k_aname[ib[1] & 7]);
                } else if (ib[1] == 0x70) {
                        print_spaces(len);
                        debug("reset\n");
                } else if (ib[1] == 0x71) {
                        print_spaces(len);
                        debug("nop\n");
                } else if (ib[1] == 0x72) {
                        print_two(ib, &len);
                        print_spaces(len);
                        debug("stop\t#0x%04x\n", ((ib[2] << 8) + ib[3]));
                } else if (ib[1] == 0x73) {
                        print_spaces(len);
                        debug("rte\n");
                } else if (ib[1] == 0x74) {
                        print_two(ib, &len);
                        print_spaces(len);
                        debug("rtd\t#0x%04x\n", ((ib[2] << 8) + ib[3]));
                } else if (ib[1] == 0x75) {
                        print_spaces(len);
                        debug("rts\n");
                } else {
                        print_spaces(len);
                        debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
                }
        } else {
                print_spaces(len);
                debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
        }

        return len;
}


#include "tmp_m68k_tail.c"

1	dpavlin	14	/*
2	dpavlin	24	* Copyright (C) 2005-2006 Anders Gavare. All rights reserved.
3	dpavlin	14	*
4			* Redistribution and use in source and binary forms, with or without
5			* modification, are permitted provided that the following conditions are met:
6			*
7			* 1. Redistributions of source code must retain the above copyright
8			* notice, this list of conditions and the following disclaimer.
9			* 2. Redistributions in binary form must reproduce the above copyright
10			* notice, this list of conditions and the following disclaimer in the
11			* documentation and/or other materials provided with the distribution.
12			* 3. The name of the author may not be used to endorse or promote products
13			* derived from this software without specific prior written permission.
14			*
15			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25			* SUCH DAMAGE.
26			*
27			*
28	dpavlin	28	* $Id: cpu_m68k.c,v 1.12 2006/07/20 21:52:59 debug Exp $
29	dpavlin	14	*
30			* Motorola 68K CPU emulation.
31			*/
32
33			#include <stdio.h>
34			#include <stdlib.h>
35			#include <string.h>
36			#include <ctype.h>
37
38			#include "cpu.h"
39			#include "machine.h"
40			#include "memory.h"
41			#include "misc.h"
42			#include "symbol.h"
43
44
45			#define DYNTRANS_32
46			#define DYNTRANS_VARIABLE_INSTRUCTION_LENGTH
47			#include "tmp_m68k_head.c"
48
49
50			static char *m68k_aname[] = { "a0", "a1", "a2", "a3", "a4", "a5", "fp", "a7" };
51
52
53			/*
54			* m68k_cpu_new():
55			*
56			* Create a new M68K cpu object.
57			*
58			* Returns 1 on success, 0 if there was no matching M68K processor with
59			* this cpu_type_name.
60			*/
61			int m68k_cpu_new(struct cpu cpu, struct memory mem, struct machine *machine,
62			int cpu_id, char *cpu_type_name)
63			{
64			if (strcasecmp(cpu_type_name, "68020") != 0)
65			return 0;
66
67	dpavlin	28	cpu->run_instr = m68k_run_instr;
68	dpavlin	14	cpu->memory_rw = m68k_memory_rw;
69			cpu->update_translation_table = m68k_update_translation_table;
70	dpavlin	18	cpu->invalidate_translation_caches =
71			m68k_invalidate_translation_caches;
72	dpavlin	14	cpu->invalidate_code_translation = m68k_invalidate_code_translation;
73			cpu->is_32bit = 1;
74
75			cpu->byte_order = EMUL_BIG_ENDIAN;
76
77			/* Only show name and caches etc for CPU nr 0 (in SMP machines): */
78			if (cpu_id == 0) {
79			debug("%s", cpu->name);
80			}
81
82			return 1;
83			}
84
85
86			/*
87			* m68k_cpu_list_available_types():
88			*
89			* Print a list of available M68K CPU types.
90			*/
91			void m68k_cpu_list_available_types(void)
92			{
93			debug("68020\n");
94			/* TODO */
95			}
96
97
98			/*
99			* m68k_cpu_dumpinfo():
100			*/
101			void m68k_cpu_dumpinfo(struct cpu *cpu)
102			{
103			/* TODO */
104			debug("\n");
105			}
106
107
108			/*
109			* m68k_cpu_register_dump():
110			*
111			* Dump cpu registers in a relatively readable format.
112			*
113			* gprs: set to non-zero to dump GPRs and some special-purpose registers.
114			* coprocs: set bit 0..3 to dump registers in coproc 0..3.
115			*/
116			void m68k_cpu_register_dump(struct cpu *cpu, int gprs, int coprocs)
117			{
118			char *symbol;
119			uint64_t offset;
120			int x = cpu->cpu_id;
121
122			if (gprs) {
123			/* Special registers (pc, ...) first: */
124			symbol = get_symbol_name(&cpu->machine->symbol_context,
125			cpu->pc, &offset);
126
127	dpavlin	28	debug("cpu%i: pc = 0x%08"PRIx32, x, (uint32_t)cpu->pc);
128	dpavlin	14	debug(" <%s>\n", symbol != NULL? symbol : " no symbol ");
129			}
130			}
131
132
133			/*
134			* m68k_cpu_register_match():
135			*/
136			void m68k_cpu_register_match(struct machine m, char name,
137			int writeflag, uint64_t valuep, int match_register)
138			{
139			int cpunr = 0;
140
141			/* CPU number: */
142
143			/* TODO */
144
145			/* Register name: */
146			if (strcasecmp(name, "pc") == 0) {
147			if (writeflag) {
148			m->cpus[cpunr]->pc = *valuep;
149			} else
150			*valuep = m->cpus[cpunr]->pc;
151			*match_register = 1;
152			}
153			}
154
155
156			/*
157	dpavlin	24	* m68k_cpu_tlbdump():
158			*
159			* Called from the debugger to dump the TLB in a readable format.
160			* x is the cpu number to dump, or -1 to dump all CPUs.
161			*
162			* If rawflag is nonzero, then the TLB contents isn't formated nicely,
163			* just dumped.
164			*/
165			void m68k_cpu_tlbdump(struct machine *m, int x, int rawflag)
166			{
167			}
168
169
170			/*
171			* m68k_cpu_gdb_stub():
172			*
173			* Execute a "remote GDB" command. Returns a newly allocated response string
174			* on success, NULL on failure.
175			*/
176			char m68k_cpu_gdb_stub(struct cpu cpu, char *cmd)
177			{
178			fatal("m68k_cpu_gdb_stub(): TODO\n");
179			return NULL;
180			}
181
182
183			/*
184	dpavlin	14	* m68k_cpu_interrupt():
185			*/
186			int m68k_cpu_interrupt(struct cpu *cpu, uint64_t irq_nr)
187			{
188			fatal("m68k_cpu_interrupt(): TODO\n");
189			return 0;
190			}
191
192
193			/*
194			* m68k_cpu_interrupt_ack():
195			*/
196			int m68k_cpu_interrupt_ack(struct cpu *cpu, uint64_t irq_nr)
197			{
198			/* fatal("m68k_cpu_interrupt_ack(): TODO\n"); */
199			return 0;
200			}
201
202
203			/* Helper functions: */
204			static void print_two(unsigned char instr, int len)
205			{ debug(" %02x%02x", instr[len], instr[len+1]); (*len) += 2; }
206			static void print_spaces(int len) { int i; debug(" "); for (i=0; i<16-len/2*5;
207			i++) debug(" "); }
208
209
210			/*
211			* m68k_cpu_disassemble_instr():
212			*
213			* Convert an instruction word into human readable format, for instruction
214			* tracing.
215			*
216			* If running is 1, cpu->pc should be the address of the instruction.
217			*
218			* If running is 0, things that depend on the runtime environment (eg.
219			* register contents) will not be shown, and addr will be used instead of
220			* cpu->pc for relative addresses.
221			*/
222			int m68k_cpu_disassemble_instr(struct cpu cpu, unsigned char ib,
223	dpavlin	24	int running, uint64_t dumpaddr)
224	dpavlin	14	{
225			uint64_t offset;
226			int len = 0;
227			char *symbol;
228
229			if (running)
230			dumpaddr = cpu->pc;
231
232			symbol = get_symbol_name(&cpu->machine->symbol_context,
233			dumpaddr, &offset);
234			if (symbol != NULL && offset==0)
235			debug("<%s>\n", symbol);
236
237			if (cpu->machine->ncpus > 1 && running)
238			debug("cpu%i: ", cpu->cpu_id);
239
240			debug("0x%08x: ", (int)dumpaddr);
241
242			print_two(ib, &len);
243
244			if (ib[0] == 0x48) {
245			if (ib[1] >= 0x40 && ib[1] <= 0x47) {
246			print_spaces(len);
247			debug("swap\td%i\n", ib[1] & 7);
248			} else if (ib[1] >= 0x48 && ib[1] <= 0x4f) {
249			print_spaces(len);
250			debug("bkpt\t#%i\n", ib[1] & 7);
251			} else {
252			print_spaces(len);
253			debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
254			}
255			} else if (ib[0] == 0x4a) {
256			if (ib[1] == 0xfc) {
257			print_spaces(len);
258			debug("illegal\n");
259			} else {
260			print_spaces(len);
261			debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
262			}
263			} else if (ib[0] == 0x4e) {
264			if (ib[1] >= 0x40 && ib[1] <= 0x4f) {
265			print_spaces(len);
266			debug("trap\t#%i\n", ib[1] & 15);
267			} else if (ib[1] >= 0x50 && ib[1] <= 0x57) {
268			print_two(ib, &len);
269			print_spaces(len);
270			debug("linkw\t%%%s,#%i\n", m68k_aname[ib[1] & 7],
271			((ib[2] << 8) + ib[3]));
272			} else if (ib[1] >= 0x58 && ib[1] <= 0x5f) {
273			print_spaces(len);
274			debug("unlk\t%%%s\n", m68k_aname[ib[1] & 7]);
275			} else if (ib[1] == 0x70) {
276			print_spaces(len);
277			debug("reset\n");
278			} else if (ib[1] == 0x71) {
279			print_spaces(len);
280			debug("nop\n");
281			} else if (ib[1] == 0x72) {
282			print_two(ib, &len);
283			print_spaces(len);
284			debug("stop\t#0x%04x\n", ((ib[2] << 8) + ib[3]));
285			} else if (ib[1] == 0x73) {
286			print_spaces(len);
287			debug("rte\n");
288			} else if (ib[1] == 0x74) {
289			print_two(ib, &len);
290			print_spaces(len);
291			debug("rtd\t#0x%04x\n", ((ib[2] << 8) + ib[3]));
292			} else if (ib[1] == 0x75) {
293			print_spaces(len);
294			debug("rts\n");
295			} else {
296			print_spaces(len);
297			debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
298			}
299			} else {
300			print_spaces(len);
301			debug("UNIMPLEMENTED 0x%02x%02x\n", ib[0], ib[1]);
302			}
303
304			return len;
305			}
306
307
308			#include "tmp_m68k_tail.c"
309