| 1 | \r |
| 2 | // Cyclone 68000 Emulator - Header File\r |
| 3 | \r |
| 4 | // (c) Copyright 2004 Dave, All rights reserved.\r |
| 5 | // (c) 2005-2007 notaz\r |
| 6 | // Cyclone 68000 is free for non-commercial use.\r |
| 7 | \r |
| 8 | // For commercial use, separate licencing terms must be obtained.\r |
| 9 | \r |
| 10 | \r |
| 11 | #ifndef __CYCLONE_H__\r |
| 12 | #define __CYCLONE_H__\r |
| 13 | \r |
| 14 | #ifdef __cplusplus\r |
| 15 | extern "C" {\r |
| 16 | #endif\r |
| 17 | \r |
| 18 | extern int CycloneVer; // Version number of library\r |
| 19 | \r |
| 20 | struct Cyclone\r |
| 21 | {\r |
| 22 | unsigned int d[8]; // [r7,#0x00]\r |
| 23 | unsigned int a[8]; // [r7,#0x20]\r |
| 24 | unsigned int pc; // [r7,#0x40] Memory Base (.membase) + 68k PC\r |
| 25 | unsigned char srh; // [r7,#0x44] Status Register high (T_S__III)\r |
| 26 | unsigned char unused; // [r7,#0x45] Unused\r |
| 27 | unsigned char flags; // [r7,#0x46] Flags (ARM order: ____NZCV) [68k order is XNZVC]\r |
| 28 | unsigned char irq; // [r7,#0x47] IRQ level\r |
| 29 | unsigned int osp; // [r7,#0x48] Other Stack Pointer (USP/SSP)\r |
| 30 | unsigned int xc; // [r7,#0x4c] Extend flag (bit29: ??X? _)\r |
| 31 | unsigned int prev_pc; // [r7,#0x50] Set to start address of currently executed opcode + 2 (if enabled in config.h)\r |
| 32 | unsigned int jumptab; // [r7,#0x54] Jump table pointer\r |
| 33 | int state_flags; // [r7,#0x58] bit: 0: stopped state, 1: trace state, 2: activity bit, 3: addr error, 4: fatal halt\r |
| 34 | int cycles; // [r7,#0x5c] Number of cycles to execute - 1. Updates to cycles left after CycloneRun()\r |
| 35 | int membase; // [r7,#0x60] Memory Base (ARM address minus 68000 address)\r |
| 36 | unsigned int (*checkpc)(unsigned int pc); // [r7,#0x64] called to recalc Memory Base+pc\r |
| 37 | unsigned int (*read8 )(unsigned int a); // [r7,#0x68]\r |
| 38 | unsigned int (*read16 )(unsigned int a); // [r7,#0x6c]\r |
| 39 | unsigned int (*read32 )(unsigned int a); // [r7,#0x70]\r |
| 40 | void (*write8 )(unsigned int a,unsigned char d); // [r7,#0x74]\r |
| 41 | void (*write16)(unsigned int a,unsigned short d); // [r7,#0x78]\r |
| 42 | void (*write32)(unsigned int a,unsigned int d); // [r7,#0x7c]\r |
| 43 | unsigned int (*fetch8 )(unsigned int a); // [r7,#0x80]\r |
| 44 | unsigned int (*fetch16)(unsigned int a); // [r7,#0x84]\r |
| 45 | unsigned int (*fetch32)(unsigned int a); // [r7,#0x88]\r |
| 46 | int (*IrqCallback)(int int_level); // [r7,#0x8c] optional irq callback function, see config.h\r |
| 47 | void (*ResetCallback)(void); // [r7,#0x90] if enabled in config.h, calls this whenever RESET opcode is encountered.\r |
| 48 | int (*UnrecognizedCallback)(void); // [r7,#0x94] if enabled in config.h, calls this whenever unrecognized opcode is encountered.\r |
| 49 | unsigned int internal[6]; // [r7,#0x98] reserved for internal use, do not change.\r |
| 50 | };\r |
| 51 | \r |
| 52 | // Initialize. Used only if Cyclone was compiled with compressed jumptable, see config.h\r |
| 53 | void CycloneInit(void);\r |
| 54 | \r |
| 55 | // Reset\r |
| 56 | void CycloneReset(struct Cyclone *pcy);\r |
| 57 | \r |
| 58 | // Run cyclone. Cycles should be specified in context (pcy->cycles)\r |
| 59 | void CycloneRun(struct Cyclone *pcy);\r |
| 60 | \r |
| 61 | // Utility functions to get and set SR\r |
| 62 | void CycloneSetSr(struct Cyclone *pcy, unsigned int sr);\r |
| 63 | unsigned int CycloneGetSr(const struct Cyclone *pcy);\r |
| 64 | \r |
| 65 | // Generates irq exception if needed (if pcy->irq > mask).\r |
| 66 | // Returns cycles used for exception if it was generated, 0 otherwise.\r |
| 67 | int CycloneFlushIrq(struct Cyclone *pcy);\r |
| 68 | \r |
| 69 | // Functions for saving and restoring state.\r |
| 70 | // CycloneUnpack() uses checkpc(), so it must be initialized.\r |
| 71 | // save_buffer must point to buffer of 128 (0x80) bytes of size.\r |
| 72 | void CyclonePack(const struct Cyclone *pcy, void *save_buffer);\r |
| 73 | void CycloneUnpack(struct Cyclone *pcy, const void *save_buffer);\r |
| 74 | \r |
| 75 | // genesis: if 1, switch to normal TAS handlers\r |
| 76 | void CycloneSetRealTAS(int use_real);\r |
| 77 | \r |
| 78 | \r |
| 79 | // These values are special return values for IrqCallback.\r |
| 80 | \r |
| 81 | // Causes an interrupt autovector (0x18 + interrupt level) to be taken.\r |
| 82 | // This happens in a real 68K if VPA or AVEC is asserted during an interrupt\r |
| 83 | // acknowledge cycle instead of DTACK (the most common situation).\r |
| 84 | #define CYCLONE_INT_ACK_AUTOVECTOR -1\r |
| 85 | \r |
| 86 | // Causes the spurious interrupt vector (0x18) to be taken\r |
| 87 | // This happens in a real 68K if BERR is asserted during the interrupt\r |
| 88 | // acknowledge cycle (i.e. no devices responded to the acknowledge).\r |
| 89 | #define CYCLONE_INT_ACK_SPURIOUS -2\r |
| 90 | \r |
| 91 | \r |
| 92 | #ifdef __cplusplus\r |
| 93 | } // End of extern "C"\r |
| 94 | #endif\r |
| 95 | \r |
| 96 | #endif // __CYCLONE_H__\r |
| 97 | \r |