git.sesse.net Git - pistorm/blob - m68k.h

   1 /* ======================================================================== */
   2 /* ========================= LICENSING & COPYRIGHT ======================== */
   3 /* ======================================================================== */
   4 /*
   5  *                                  MUSASHI
   6  *                                Version 3.32
   7  *
   8  * A portable Motorola M680x0 processor emulation engine.
   9  * Copyright Karl Stenerud.  All rights reserved.
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  27  * THE SOFTWARE.
  28  */
  29
  30 #ifndef M68K__HEADER
  31 #define M68K__HEADER
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 #ifndef ARRAY_LENGTH
  38 #define ARRAY_LENGTH(x)         (sizeof(x) / sizeof(x[0]))
  39 #endif
  40
  41 #ifndef FALSE
  42 #define FALSE 0
  43 #define TRUE 1
  44 #endif
  45
  46 /* ======================================================================== */
  47 /* ============================= CONFIGURATION ============================ */
  48 /* ======================================================================== */
  49
  50 /* Import the configuration for this build */
  51 #ifdef MUSASHI_CNF
  52 #include MUSASHI_CNF
  53 #else
  54 #include "m68kconf.h"
  55 #endif
  56
  57 /* ======================================================================== */
  58 /* ============================ GENERAL DEFINES =========================== */
  59
  60 /* ======================================================================== */
  61
  62 /* There are 7 levels of interrupt to the 68K.
  63  * A transition from < 7 to 7 will cause a non-maskable interrupt (NMI).
  64  */
  65 #define M68K_IRQ_NONE 0
  66 #define M68K_IRQ_1    1
  67 #define M68K_IRQ_2    2
  68 #define M68K_IRQ_3    3
  69 #define M68K_IRQ_4    4
  70 #define M68K_IRQ_5    5
  71 #define M68K_IRQ_6    6
  72 #define M68K_IRQ_7    7
  73
  74
  75 /* Special interrupt acknowledge values.
  76  * Use these as special returns from the interrupt acknowledge callback
  77  * (specified later in this header).
  78  */
  79
  80 /* Causes an interrupt autovector (0x18 + interrupt level) to be taken.
  81  * This happens in a real 68K if VPA or AVEC is asserted during an interrupt
  82  * acknowledge cycle instead of DTACK.
  83  */
  84 #define M68K_INT_ACK_AUTOVECTOR    0xffffffff
  85
  86 /* Causes the spurious interrupt vector (0x18) to be taken
  87  * This happens in a real 68K if BERR is asserted during the interrupt
  88  * acknowledge cycle (i.e. no devices responded to the acknowledge).
  89  */
  90 #define M68K_INT_ACK_SPURIOUS      0xfffffffe
  91
  92
  93 /* CPU types for use in m68k_set_cpu_type() */
  94 enum
  95 {
  96         M68K_CPU_TYPE_INVALID,
  97         M68K_CPU_TYPE_68000,
  98         M68K_CPU_TYPE_68010,
  99         M68K_CPU_TYPE_68EC020,
 100         M68K_CPU_TYPE_68020,
 101         M68K_CPU_TYPE_68EC030,
 102         M68K_CPU_TYPE_68030,
 103         M68K_CPU_TYPE_68EC040,
 104         M68K_CPU_TYPE_68LC040,
 105         M68K_CPU_TYPE_68040,
 106         M68K_CPU_TYPE_SCC68070
 107 };
 108
 109 /* Registers used by m68k_get_reg() and m68k_set_reg() */
 110 typedef enum
 111 {
 112         /* Real registers */
 113         M68K_REG_D0,            /* Data registers */
 114         M68K_REG_D1,
 115         M68K_REG_D2,
 116         M68K_REG_D3,
 117         M68K_REG_D4,
 118         M68K_REG_D5,
 119         M68K_REG_D6,
 120         M68K_REG_D7,
 121         M68K_REG_A0,            /* Address registers */
 122         M68K_REG_A1,
 123         M68K_REG_A2,
 124         M68K_REG_A3,
 125         M68K_REG_A4,
 126         M68K_REG_A5,
 127         M68K_REG_A6,
 128         M68K_REG_A7,
 129         M68K_REG_PC,            /* Program Counter */
 130         M68K_REG_SR,            /* Status Register */
 131         M68K_REG_SP,            /* The current Stack Pointer (located in A7) */
 132         M68K_REG_USP,           /* User Stack Pointer */
 133         M68K_REG_ISP,           /* Interrupt Stack Pointer */
 134         M68K_REG_MSP,           /* Master Stack Pointer */
 135         M68K_REG_SFC,           /* Source Function Code */
 136         M68K_REG_DFC,           /* Destination Function Code */
 137         M68K_REG_VBR,           /* Vector Base Register */
 138         M68K_REG_CACR,          /* Cache Control Register */
 139         M68K_REG_CAAR,          /* Cache Address Register */
 140
 141         /* Assumed registers */
 142         /* These are cheat registers which emulate the 1-longword prefetch
 143          * present in the 68000 and 68010.
 144          */
 145         M68K_REG_PREF_ADDR,     /* Last prefetch address */
 146         M68K_REG_PREF_DATA,     /* Last prefetch data */
 147
 148         /* Convenience registers */
 149         M68K_REG_PPC,           /* Previous value in the program counter */
 150         M68K_REG_IR,            /* Instruction register */
 151         M68K_REG_CPU_TYPE       /* Type of CPU being run */
 152 } m68k_register_t;
 153
 154 /* ======================================================================== */
 155 /* ====================== FUNCTIONS CALLED BY THE CPU ===================== */
 156 /* ======================================================================== */
 157
 158 /* You will have to implement these functions */
 159
 160 /* read/write functions called by the CPU to access memory.
 161  * while values used are 32 bits, only the appropriate number
 162  * of bits are relevant (i.e. in write_memory_8, only the lower 8 bits
 163  * of value should be written to memory).
 164  *
 165  * NOTE: I have separated the immediate and PC-relative memory fetches
 166  *       from the other memory fetches because some systems require
 167  *       differentiation between PROGRAM and DATA fetches (usually
 168  *       for security setups such as encryption).
 169  *       This separation can either be achieved by setting
 170  *       M68K_SEPARATE_READS in m68kconf.h and defining
 171  *       the read functions, or by setting M68K_EMULATE_FC and
 172  *       making a function code callback function.
 173  *       Using the callback offers better emulation coverage
 174  *       because you can also monitor whether the CPU is in SYSTEM or
 175  *       USER mode, but it is also slower.
 176  */
 177
 178 /* Read from anywhere */
 179 unsigned int  m68k_read_memory_8(unsigned int address);
 180 unsigned int  m68k_read_memory_16(unsigned int address);
 181 unsigned int  m68k_read_memory_32(unsigned int address);
 182
 183 /* Read data immediately following the PC */
 184 unsigned int  m68k_read_immediate_16(unsigned int address);
 185 unsigned int  m68k_read_immediate_32(unsigned int address);
 186
 187 /* Read data relative to the PC */
 188 unsigned int  m68k_read_pcrelative_8(unsigned int address);
 189 unsigned int  m68k_read_pcrelative_16(unsigned int address);
 190 unsigned int  m68k_read_pcrelative_32(unsigned int address);
 191
 192 /* Memory access for the disassembler */
 193 unsigned int m68k_read_disassembler_8  (unsigned int address);
 194 unsigned int m68k_read_disassembler_16 (unsigned int address);
 195 unsigned int m68k_read_disassembler_32 (unsigned int address);
 196
 197 /* Write to anywhere */
 198 void m68k_write_memory_8(unsigned int address, unsigned int value);
 199 void m68k_write_memory_16(unsigned int address, unsigned int value);
 200 void m68k_write_memory_32(unsigned int address, unsigned int value);
 201
 202 /* Special call to simulate undocumented 68k behavior when move.l with a
 203  * predecrement destination mode is executed.
 204  * To simulate real 68k behavior, first write the high word to
 205  * [address+2], and then write the low word to [address].
 206  *
 207  * Enable this functionality with M68K_SIMULATE_PD_WRITES in m68kconf.h.
 208  */
 209 void m68k_write_memory_32_pd(unsigned int address, unsigned int value);
 210
 211
 212
 213 /* ======================================================================== */
 214 /* ============================== CALLBACKS =============================== */
 215 /* ======================================================================== */
 216
 217 /* These functions allow you to set callbacks to the host when specific events
 218  * occur.  Note that you must enable the corresponding value in m68kconf.h
 219  * in order for these to do anything useful.
 220  * Note: I have defined default callbacks which are used if you have enabled
 221  * the corresponding #define in m68kconf.h but either haven't assigned a
 222  * callback or have assigned a callback of NULL.
 223  */
 224
 225 /* Set the callback for an interrupt acknowledge.
 226  * You must enable M68K_EMULATE_INT_ACK in m68kconf.h.
 227  * The CPU will call the callback with the interrupt level being acknowledged.
 228  * The host program must return either a vector from 0x02-0xff, or one of the
 229  * special interrupt acknowledge values specified earlier in this header.
 230  * If this is not implemented, the CPU will always assume an autovectored
 231  * interrupt, and will automatically clear the interrupt request when it
 232  * services the interrupt.
 233  * Default behavior: return M68K_INT_ACK_AUTOVECTOR.
 234  */
 235 void m68k_set_int_ack_callback(int  (*callback)(int int_level));
 236
 237
 238 /* Set the callback for a breakpoint acknowledge (68010+).
 239  * You must enable M68K_EMULATE_BKPT_ACK in m68kconf.h.
 240  * The CPU will call the callback with whatever was in the data field of the
 241  * BKPT instruction for 68020+, or 0 for 68010.
 242  * Default behavior: do nothing.
 243  */
 244 void m68k_set_bkpt_ack_callback(void (*callback)(unsigned int data));
 245
 246
 247 /* Set the callback for the RESET instruction.
 248  * You must enable M68K_EMULATE_RESET in m68kconf.h.
 249  * The CPU calls this callback every time it encounters a RESET instruction.
 250  * Default behavior: do nothing.
 251  */
 252 void m68k_set_reset_instr_callback(void  (*callback)(void));
 253
 254
 255 /* Set the callback for informing of a large PC change.
 256  * You must enable M68K_MONITOR_PC in m68kconf.h.
 257  * The CPU calls this callback with the new PC value every time the PC changes
 258  * by a large value (currently set for changes by longwords).
 259  * Default behavior: do nothing.
 260  */
 261 void m68k_set_pc_changed_callback(void  (*callback)(unsigned int new_pc));
 262
 263 /* Set the callback for the TAS instruction.
 264  * You must enable M68K_TAS_HAS_CALLBACK in m68kconf.h.
 265  * The CPU calls this callback every time it encounters a TAS instruction.
 266  * Default behavior: return 1, allow writeback.
 267  */
 268 void m68k_set_tas_instr_callback(int  (*callback)(void));
 269
 270 /* Set the callback for illegal instructions.
 271  * You must enable M68K_ILLG_HAS_CALLBACK in m68kconf.h.
 272  * The CPU calls this callback every time it encounters an illegal instruction
 273  * which must return 1 if it handles the instruction normally or 0 if it's really an illegal instruction.
 274  * Default behavior: return 0, exception will occur.
 275  */
 276 void m68k_set_illg_instr_callback(int  (*callback)(int));
 277
 278 /* Set the callback for CPU function code changes.
 279  * You must enable M68K_EMULATE_FC in m68kconf.h.
 280  * The CPU calls this callback with the function code before every memory
 281  * access to set the CPU's function code according to what kind of memory
 282  * access it is (supervisor/user, program/data and such).
 283  * Default behavior: do nothing.
 284  */
 285 void m68k_set_fc_callback(void  (*callback)(unsigned int new_fc));
 286
 287
 288 /* Set a callback for the instruction cycle of the CPU.
 289  * You must enable M68K_INSTRUCTION_HOOK in m68kconf.h.
 290  * The CPU calls this callback just before fetching the opcode in the
 291  * instruction cycle.
 292  * Default behavior: do nothing.
 293  */
 294 void m68k_set_instr_hook_callback(void  (*callback)(unsigned int pc));
 295
 296
 297
 298 /* ======================================================================== */
 299 /* ====================== FUNCTIONS TO ACCESS THE CPU ===================== */
 300 /* ======================================================================== */
 301
 302 /* Use this function to set the CPU type you want to emulate.
 303  * Currently supported types are: M68K_CPU_TYPE_68000, M68K_CPU_TYPE_68010,
 304  * M68K_CPU_TYPE_EC020, and M68K_CPU_TYPE_68020.
 305  */
 306 void m68k_set_cpu_type(unsigned int cpu_type);
 307
 308 /* Do whatever initialisations the core requires.  Should be called
 309  * at least once at init time.
 310  */
 311 void m68k_init(void);
 312
 313 /* Pulse the RESET pin on the CPU.
 314  * You *MUST* reset the CPU at least once to initialize the emulation
 315  * Note: If you didn't call m68k_set_cpu_type() before resetting
 316  *       the CPU for the first time, the CPU will be set to
 317  *       M68K_CPU_TYPE_68000.
 318  */
 319 void m68k_pulse_reset(void);
 320
 321 /* execute num_cycles worth of instructions.  returns number of cycles used */
 322 int m68k_execute(int num_cycles);
 323
 324 /* These functions let you read/write/modify the number of cycles left to run
 325  * while m68k_execute() is running.
 326  * These are useful if the 68k accesses a memory-mapped port on another device
 327  * that requires immediate processing by another CPU.
 328  */
 329 int m68k_cycles_run(void);              /* Number of cycles run so far */
 330 int m68k_cycles_remaining(void);        /* Number of cycles left */
 331 void m68k_modify_timeslice(int cycles); /* Modify cycles left */
 332 void m68k_end_timeslice(void);          /* End timeslice now */
 333
 334 /* Set the IPL0-IPL2 pins on the CPU (IRQ).
 335  * A transition from < 7 to 7 will cause a non-maskable interrupt (NMI).
 336  * Setting IRQ to 0 will clear an interrupt request.
 337  */
 338 void m68k_set_irq(unsigned int int_level);
 339
 340 /* Set the virtual irq lines, where the highest level
 341  * active line is automatically selected.  If you use this function,
 342  * do not use m68k_set_irq.
 343  */
 344 void m68k_set_virq(unsigned int level, unsigned int active);
 345 unsigned int m68k_get_virq(unsigned int level);
 346
 347 /* Halt the CPU as if you pulsed the HALT pin. */
 348 void m68k_pulse_halt(void);
 349
 350
 351 /* Trigger a bus error exception */
 352 void m68k_pulse_bus_error(void);
 353
 354
 355 /* Context switching to allow multiple CPUs */
 356
 357 /* Get the size of the cpu context in bytes */
 358 unsigned int m68k_context_size(void);
 359
 360 /* Get a cpu context */
 361 unsigned int m68k_get_context(void* dst);
 362
 363 /* set the current cpu context */
 364 void m68k_set_context(void* dst);
 365
 366 /* Register the CPU state information */
 367 void m68k_state_register(const char *type, int index);
 368
 369
 370 /* Peek at the internals of a CPU context.  This can either be a context
 371  * retrieved using m68k_get_context() or the currently running context.
 372  * If context is NULL, the currently running CPU context will be used.
 373  */
 374 unsigned int m68k_get_reg(void* context, m68k_register_t reg);
 375
 376 /* Poke values into the internals of the currently running CPU context */
 377 void m68k_set_reg(m68k_register_t reg, unsigned int value);
 378
 379 /* Check if an instruction is valid for the specified CPU type */
 380 unsigned int m68k_is_valid_instruction(unsigned int instruction, unsigned int cpu_type);
 381
 382 /* Disassemble 1 instruction using the epecified CPU type at pc.  Stores
 383  * disassembly in str_buff and returns the size of the instruction in bytes.
 384  */
 385 unsigned int m68k_disassemble(char* str_buff, unsigned int pc, unsigned int cpu_type);
 386
 387 /* Same as above but accepts raw opcode data directly rather than fetching
 388  * via the read/write interfaces.
 389  */
 390 unsigned int m68k_disassemble_raw(char* str_buff, unsigned int pc, const unsigned char* opdata, const unsigned char* argdata, unsigned int cpu_type);
 391
 392
 393 /* ======================================================================== */
 394 /* ============================== MAME STUFF ============================== */
 395 /* ======================================================================== */
 396
 397 #if M68K_COMPILE_FOR_MAME == OPT_ON
 398 #include "m68kmame.h"
 399 #endif /* M68K_COMPILE_FOR_MAME */
 400
 401
 402 /* ======================================================================== */
 403 /* ============================== END OF FILE ============================= */
 404 /* ======================================================================== */
 405
 406 #ifdef __cplusplus
 407 }
 408 #endif
 409
 410
 411 #endif /* M68K__HEADER */