Shamusworld >> Repos - virtualjaguar/blob - src/m68k.h

   1 #ifndef M68K__HEADER
   2 #define M68K__HEADER
   3
   4 #ifdef __cplusplus
   5 extern "C" {
   6 #endif
   7
   8 /* ======================================================================== */
   9 /* ========================= LICENSING & COPYRIGHT ======================== */
  10 /* ======================================================================== */
  11 /*
  12  *                                  MUSASHI
  13  *                                Version 3.3
  14  *
  15  * A portable Motorola M680x0 processor emulation engine.
  16  * Copyright 1998-2001 Karl Stenerud.  All rights reserved.
  17  *
  18  * This code may be freely used for non-commercial purposes as long as this
  19  * copyright notice remains unaltered in the source code and any binary files
  20  * containing this code in compiled form.
  21  *
  22  * All other lisencing terms must be negotiated with the author
  23  * (Karl Stenerud).
  24  *
  25  * The latest version of this code can be obtained at:
  26  * http://kstenerud.cjb.net
  27  */
  28
  29
  30
  31 /* ======================================================================== */
  32 /* ============================ GENERAL DEFINES =========================== */
  33
  34 /* ======================================================================== */
  35
  36 /* There are 7 levels of interrupt to the 68K.
  37  * A transition from < 7 to 7 will cause a non-maskable interrupt (NMI).
  38  */
  39 #define M68K_IRQ_NONE 0
  40 #define M68K_IRQ_1    1
  41 #define M68K_IRQ_2    2
  42 #define M68K_IRQ_3    3
  43 #define M68K_IRQ_4    4
  44 #define M68K_IRQ_5    5
  45 #define M68K_IRQ_6    6
  46 #define M68K_IRQ_7    7
  47
  48
  49 /* Special interrupt acknowledge values.
  50  * Use these as special returns from the interrupt acknowledge callback
  51  * (specified later in this header).
  52  */
  53
  54 /* Causes an interrupt autovector (0x18 + interrupt level) to be taken.
  55  * This happens in a real 68K if VPA or AVEC is asserted during an interrupt
  56  * acknowledge cycle instead of DTACK.
  57  */
  58 #define M68K_INT_ACK_AUTOVECTOR    0xffffffff
  59
  60 /* Causes the spurious interrupt vector (0x18) to be taken
  61  * This happens in a real 68K if BERR is asserted during the interrupt
  62  * acknowledge cycle (i.e. no devices responded to the acknowledge).
  63  */
  64 #define M68K_INT_ACK_SPURIOUS      0xfffffffe
  65
  66
  67 /* CPU types for use in m68k_set_cpu_type() */
  68 enum
  69 {
  70         M68K_CPU_TYPE_INVALID,
  71         M68K_CPU_TYPE_68000,
  72         M68K_CPU_TYPE_68010,
  73         M68K_CPU_TYPE_68EC020,
  74         M68K_CPU_TYPE_68020,
  75         M68K_CPU_TYPE_68030,    /* Supported by disassembler ONLY */
  76         M68K_CPU_TYPE_68040             /* Supported by disassembler ONLY */
  77 };
  78
  79 /* Registers used by m68k_get_reg() and m68k_set_reg() */
  80 typedef enum
  81 {
  82         /* Real registers */
  83         M68K_REG_D0,            /* Data registers */
  84         M68K_REG_D1,
  85         M68K_REG_D2,
  86         M68K_REG_D3,
  87         M68K_REG_D4,
  88         M68K_REG_D5,
  89         M68K_REG_D6,
  90         M68K_REG_D7,
  91         M68K_REG_A0,            /* Address registers */
  92         M68K_REG_A1,
  93         M68K_REG_A2,
  94         M68K_REG_A3,
  95         M68K_REG_A4,
  96         M68K_REG_A5,
  97         M68K_REG_A6,
  98         M68K_REG_A7,
  99         M68K_REG_PC,            /* Program Counter */
 100         M68K_REG_SR,            /* Status Register */
 101         M68K_REG_SP,            /* The current Stack Pointer (located in A7) */
 102         M68K_REG_USP,           /* User Stack Pointer */
 103         M68K_REG_ISP,           /* Interrupt Stack Pointer */
 104         M68K_REG_MSP,           /* Master Stack Pointer */
 105         M68K_REG_SFC,           /* Source Function Code */
 106         M68K_REG_DFC,           /* Destination Function Code */
 107         M68K_REG_VBR,           /* Vector Base Register */
 108         M68K_REG_CACR,          /* Cache Control Register */
 109         M68K_REG_CAAR,          /* Cache Address Register */
 110
 111         /* Assumed registers */
 112         /* These are cheat registers which emulate the 1-longword prefetch
 113          * present in the 68000 and 68010.
 114          */
 115         M68K_REG_PREF_ADDR,     /* Last prefetch address */
 116         M68K_REG_PREF_DATA,     /* Last prefetch data */
 117
 118         /* Convenience registers */
 119         M68K_REG_PPC,           /* Previous value in the program counter */
 120         M68K_REG_IR,            /* Instruction register */
 121         M68K_REG_CPU_TYPE       /* Type of CPU being run */
 122 } m68k_register_t;
 123
 124 /* ======================================================================== */
 125 /* ====================== FUNCTIONS CALLED BY THE CPU ===================== */
 126 /* ======================================================================== */
 127
 128 /* You will have to implement these functions */
 129
 130 /* read/write functions called by the CPU to access memory.
 131  * while values used are 32 bits, only the appropriate number
 132  * of bits are relevant (i.e. in write_memory_8, only the lower 8 bits
 133  * of value should be written to memory).
 134  *
 135  * NOTE: I have separated the immediate and PC-relative memory fetches
 136  *       from the other memory fetches because some systems require
 137  *       differentiation between PROGRAM and DATA fetches (usually
 138  *       for security setups such as encryption).
 139  *       This separation can either be achieved by setting
 140  *       M68K_SEPARATE_READS in m68kconf.h and defining
 141  *       the read functions, or by setting M68K_EMULATE_FC and
 142  *       making a function code callback function.
 143  *       Using the callback offers better emulation coverage
 144  *       because you can also monitor whether the CPU is in SYSTEM or
 145  *       USER mode, but it is also slower.
 146  */
 147
 148 /* Read from anywhere */
 149 unsigned int  m68k_read_memory_8(unsigned int address);
 150 unsigned int  m68k_read_memory_16(unsigned int address);
 151 unsigned int  m68k_read_memory_32(unsigned int address);
 152
 153 /* Read data immediately following the PC */
 154 unsigned int  m68k_read_immediate_16(unsigned int address);
 155 unsigned int  m68k_read_immediate_32(unsigned int address);
 156
 157 /* Read data relative to the PC */
 158 unsigned int  m68k_read_pcrelative_8(unsigned int address);
 159 unsigned int  m68k_read_pcrelative_16(unsigned int address);
 160 unsigned int  m68k_read_pcrelative_32(unsigned int address);
 161
 162 /* Memory access for the disassembler */
 163 unsigned int m68k_read_disassembler_8  (unsigned int address);
 164 unsigned int m68k_read_disassembler_16 (unsigned int address);
 165 unsigned int m68k_read_disassembler_32 (unsigned int address);
 166
 167 /* Write to anywhere */
 168 void m68k_write_memory_8(unsigned int address, unsigned int value);
 169 void m68k_write_memory_16(unsigned int address, unsigned int value);
 170 void m68k_write_memory_32(unsigned int address, unsigned int value);
 171
 172
 173
 174 /* ======================================================================== */
 175 /* ============================== CALLBACKS =============================== */
 176 /* ======================================================================== */
 177
 178 /* These functions allow you to set callbacks to the host when specific events
 179  * occur.  Note that you must enable the corresponding value in m68kconf.h
 180  * in order for these to do anything useful.
 181  * Note: I have defined default callbacks which are used if you have enabled
 182  * the corresponding #define in m68kconf.h but either haven't assigned a
 183  * callback or have assigned a callback of NULL.
 184  */
 185
 186 /* Set the callback for an interrupt acknowledge.
 187  * You must enable M68K_EMULATE_INT_ACK in m68kconf.h.
 188  * The CPU will call the callback with the interrupt level being acknowledged.
 189  * The host program must return either a vector from 0x02-0xff, or one of the
 190  * special interrupt acknowledge values specified earlier in this header.
 191  * If this is not implemented, the CPU will always assume an autovectored
 192  * interrupt, and will automatically clear the interrupt request when it
 193  * services the interrupt.
 194  * Default behavior: return M68K_INT_ACK_AUTOVECTOR.
 195  */
 196 void m68k_set_int_ack_callback(int  (*callback)(int int_level));
 197
 198
 199 /* Set the callback for a breakpoint acknowledge (68010+).
 200  * You must enable M68K_EMULATE_BKPT_ACK in m68kconf.h.
 201  * The CPU will call the callback with whatever was in the data field of the
 202  * BKPT instruction for 68020+, or 0 for 68010.
 203  * Default behavior: do nothing.
 204  */
 205 void m68k_set_bkpt_ack_callback(void (*callback)(unsigned int data));
 206
 207
 208 /* Set the callback for the RESET instruction.
 209  * You must enable M68K_EMULATE_RESET in m68kconf.h.
 210  * The CPU calls this callback every time it encounters a RESET instruction.
 211  * Default behavior: do nothing.
 212  */
 213 void m68k_set_reset_instr_callback(void  (*callback)(void));
 214
 215
 216 /* Set the callback for informing of a large PC change.
 217  * You must enable M68K_MONITOR_PC in m68kconf.h.
 218  * The CPU calls this callback with the new PC value every time the PC changes
 219  * by a large value (currently set for changes by longwords).
 220  * Default behavior: do nothing.
 221  */
 222 void m68k_set_pc_changed_callback(void  (*callback)(unsigned int new_pc));
 223
 224
 225 /* Set the callback for CPU function code changes.
 226  * You must enable M68K_EMULATE_FC in m68kconf.h.
 227  * The CPU calls this callback with the function code before every memory
 228  * access to set the CPU's function code according to what kind of memory
 229  * access it is (supervisor/user, program/data and such).
 230  * Default behavior: do nothing.
 231  */
 232 void m68k_set_fc_callback(void  (*callback)(unsigned int new_fc));
 233
 234
 235 /* Set a callback for the instruction cycle of the CPU.
 236  * You must enable M68K_INSTRUCTION_HOOK in m68kconf.h.
 237  * The CPU calls this callback just before fetching the opcode in the
 238  * instruction cycle.
 239  * Default behavior: do nothing.
 240  */
 241 void m68k_set_instr_hook_callback(void  (*callback)(void));
 242
 243
 244
 245 /* ======================================================================== */
 246 /* ====================== FUNCTIONS TO ACCESS THE CPU ===================== */
 247 /* ======================================================================== */
 248
 249 /* Use this function to set the CPU type you want to emulate.
 250  * Currently supported types are: M68K_CPU_TYPE_68000, M68K_CPU_TYPE_68010,
 251  * M68K_CPU_TYPE_EC020, and M68K_CPU_TYPE_68020.
 252  */
 253 void m68k_set_cpu_type(unsigned int cpu_type);
 254
 255 /* Pulse the RESET pin on the CPU.
 256  * You *MUST* reset the CPU at least once to initialize the emulation
 257  * Note: If you didn't call m68k_set_cpu_type() before resetting
 258  *       the CPU for the first time, the CPU will be set to
 259  *       M68K_CPU_TYPE_68000.
 260  */
 261 void m68k_pulse_reset(void);
 262
 263 /* execute num_cycles worth of instructions.  returns number of cycles used */
 264 int m68k_execute(int num_cycles);
 265
 266 /* These functions let you read/write/modify the number of cycles left to run
 267  * while m68k_execute() is running.
 268  * These are useful if the 68k accesses a memory-mapped port on another device
 269  * that requires immediate processing by another CPU.
 270  */
 271 int m68k_cycles_run(void);              /* Number of cycles run so far */
 272 int m68k_cycles_remaining(void);        /* Number of cycles left */
 273 void m68k_modify_timeslice(int cycles); /* Modify cycles left */
 274 void m68k_end_timeslice(void);          /* End timeslice now */
 275
 276 /* Set the IPL0-IPL2 pins on the CPU (IRQ).
 277  * A transition from < 7 to 7 will cause a non-maskable interrupt (NMI).
 278  * Setting IRQ to 0 will clear an interrupt request.
 279  */
 280 void m68k_set_irq(unsigned int int_level);
 281
 282
 283 /* Halt the CPU as if you pulsed the HALT pin. */
 284 void m68k_pulse_halt(void);
 285
 286
 287 /* Context switching to allow multiple CPUs */
 288
 289 /* Get the size of the cpu context in bytes */
 290 unsigned int m68k_context_size(void);
 291
 292 /* Get a cpu context */
 293 unsigned int m68k_get_context(void* dst);
 294
 295 /* set the current cpu context */
 296 void m68k_set_context(void* dst);
 297
 298 /* Save the current cpu context to disk.
 299  * You must provide a function pointer of the form:
 300  * void save_value(char* identifier, unsigned int value)
 301  */
 302 void m68k_save_context( void (*save_value)(char* identifier, unsigned int value));
 303
 304 /* Load a cpu context from disk.
 305  * You must provide a function pointer of the form:
 306  * unsigned int load_value(char* identifier)
 307  */
 308 void m68k_load_context(unsigned int (*load_value)(char* identifier));
 309
 310
 311
 312 /* Peek at the internals of a CPU context.  This can either be a context
 313  * retrieved using m68k_get_context() or the currently running context.
 314  * If context is NULL, the currently running CPU context will be used.
 315  */
 316 unsigned int m68k_get_reg(void* context, m68k_register_t reg);
 317
 318 /* Poke values into the internals of the currently running CPU context */
 319 void m68k_set_reg(m68k_register_t reg, unsigned int value);
 320
 321 /* Check if an instruction is valid for the specified CPU type */
 322 unsigned int m68k_is_valid_instruction(unsigned int instruction, unsigned int cpu_type);
 323
 324 /* Disassemble 1 instruction using the epecified CPU type at pc.  Stores
 325  * disassembly in str_buff and returns the size of the instruction in bytes.
 326  */
 327 unsigned int m68k_disassemble(char* str_buff, unsigned int pc, unsigned int cpu_type);
 328
 329 /* ======================================================================== */
 330 /* ============================= CONFIGURATION ============================ */
 331 /* ======================================================================== */
 332
 333 /* Import the configuration for this build */
 334 #include "m68kconf.h"
 335
 336
 337
 338 /* ======================================================================== */
 339 /* ============================== END OF FILE ============================= */
 340 /* ======================================================================== */
 341
 342 #ifdef __cplusplus
 343 }
 344 #endif
 345
 346 #endif /* M68K__HEADER */