fix compatibility with ancient gas
[cyclone68000.git] / Cyclone.h
CommitLineData
6003a768 1\r
2// Cyclone 68000 Emulator - Header File\r
3\r
d9d77995 4// Copyright (c) 2004,2011 FinalDave (emudave (at) gmail.com)\r
5// Copyright (c) 2005-2011 GraÅžvydas "notaz" Ignotas (notasas (at) gmail.com)\r
c41b9b97 6\r
6003a768 7// This code is licensed under the GNU General Public License version 2.0 and the MAME License.\r
8// You can choose the license that has the most advantages for you.\r
9\r
10// SVN repository can be found at http://code.google.com/p/cyclone68000/\r
11\r
d9d77995 12\r
13#ifndef __CYCLONE_H__\r
14#define __CYCLONE_H__\r
15\r
6003a768 16#ifdef __cplusplus\r
17extern "C" {\r
18#endif\r
19\r
20extern int CycloneVer; // Version number of library\r
21\r
b889883d 22extern long CycloneJumpTab[65536]; // default jump table\r
23\r
6003a768 24struct Cyclone\r
25{\r
d9d77995 26 unsigned int d[8]; // [r7,#0x00]\r
27 unsigned int a[8]; // [r7,#0x20]\r
28 unsigned int pc; // [r7,#0x40] Memory Base (.membase) + 68k PC\r
29 unsigned char srh; // [r7,#0x44] Status Register high (T_S__III)\r
c6237d9e 30 unsigned char not_pol;// [r7,#0x45] not polling\r
d9d77995 31 unsigned char flags; // [r7,#0x46] Flags (ARM order: ____NZCV) [68k order is XNZVC]\r
32 unsigned char irq; // [r7,#0x47] IRQ level\r
33 unsigned int osp; // [r7,#0x48] Other Stack Pointer (USP/SSP)\r
34 unsigned int xc; // [r7,#0x4c] Extend flag (bit29: ??X? _)\r
35 unsigned int prev_pc; // [r7,#0x50] Set to start address of currently executed opcode + 2 (if enabled in config.h)\r
36 unsigned int jumptab; // [r7,#0x54] Jump table pointer\r
37 int state_flags; // [r7,#0x58] bit: 0: stopped state, 1: trace state, 2: activity bit, 3: addr error, 4: fatal halt\r
38 int cycles; // [r7,#0x5c] Number of cycles to execute - 1. Updates to cycles left after CycloneRun()\r
39 int membase; // [r7,#0x60] Memory Base (ARM address minus 68000 address)\r
40 unsigned int (*checkpc)(unsigned int pc); // [r7,#0x64] called to recalc Memory Base+pc\r
41 unsigned int (*read8 )(unsigned int a); // [r7,#0x68]\r
42 unsigned int (*read16 )(unsigned int a); // [r7,#0x6c]\r
43 unsigned int (*read32 )(unsigned int a); // [r7,#0x70]\r
6003a768 44 void (*write8 )(unsigned int a,unsigned char d); // [r7,#0x74]\r
45 void (*write16)(unsigned int a,unsigned short d); // [r7,#0x78]\r
46 void (*write32)(unsigned int a,unsigned int d); // [r7,#0x7c]\r
d9d77995 47 unsigned int (*fetch8 )(unsigned int a); // [r7,#0x80]\r
48 unsigned int (*fetch16)(unsigned int a); // [r7,#0x84]\r
49 unsigned int (*fetch32)(unsigned int a); // [r7,#0x88]\r
50 int (*IrqCallback)(int int_level); // [r7,#0x8c] optional irq callback function, see config.h\r
51 void (*ResetCallback)(void); // [r7,#0x90] if enabled in config.h, calls this whenever RESET opcode is encountered.\r
52 int (*UnrecognizedCallback)(void); // [r7,#0x94] if enabled in config.h, calls this whenever unrecognized opcode is encountered.\r
66dda842 53 void *internal_CycloneEnd; // [r7,#0x98] internal, do not modify\r
54 int internal_s_cycles; // [r7,#0x9c] internal, do not modify\r
55 void *internal_s_CycloneEnd; // [r7,#0xa0] internal, do not modify\r
56 unsigned int internal[3]; // [r7,#0xa4] reserved for internal use, do not change.\r
6003a768 57};\r
58\r
d9d77995 59// Initialize. Used only if Cyclone was compiled with compressed jumptable, see config.h\r
b889883d 60#define CycloneInit() \\r
61 CycloneInitJT(CycloneJumpTab)\r
62void CycloneInitJT(void *jt);\r
d9d77995 63\r
64// Reset\r
b889883d 65#define CycloneReset(pcy) \\r
66 CycloneResetJT(pcy, CycloneJumpTab)\r
67void CycloneResetJT(struct Cyclone *pcy, void *jt);\r
d9d77995 68\r
69// Run cyclone. Cycles should be specified in context (pcy->cycles)\r
6003a768 70void CycloneRun(struct Cyclone *pcy);\r
71\r
d9d77995 72// Utility functions to get and set SR\r
73void CycloneSetSr(struct Cyclone *pcy, unsigned int sr);\r
74unsigned int CycloneGetSr(const struct Cyclone *pcy);\r
75\r
76// Generates irq exception if needed (if pcy->irq > mask).\r
77// Returns cycles used for exception if it was generated, 0 otherwise.\r
78int CycloneFlushIrq(struct Cyclone *pcy);\r
79\r
80// Functions for saving and restoring state.\r
81// CycloneUnpack() uses checkpc(), so it must be initialized.\r
82// save_buffer must point to buffer of 128 (0x80) bytes of size.\r
83void CyclonePack(const struct Cyclone *pcy, void *save_buffer);\r
84void CycloneUnpack(struct Cyclone *pcy, const void *save_buffer);\r
85\r
86// genesis: if 1, switch to normal TAS handlers\r
b889883d 87#define CycloneSetRealTAS(use_real) \\r
88 CycloneSetRealTAS_JT(use_real, CycloneJumpTab)\r
89void CycloneSetRealTAS_JT(int use_real, void *jt);\r
d9d77995 90\r
91\r
92// These values are special return values for IrqCallback.\r
93\r
94// Causes an interrupt autovector (0x18 + interrupt level) to be taken.\r
95// This happens in a real 68K if VPA or AVEC is asserted during an interrupt\r
96// acknowledge cycle instead of DTACK (the most common situation).\r
97#define CYCLONE_INT_ACK_AUTOVECTOR -1\r
98\r
99// Causes the spurious interrupt vector (0x18) to be taken\r
100// This happens in a real 68K if BERR is asserted during the interrupt\r
101// acknowledge cycle (i.e. no devices responded to the acknowledge).\r
102#define CYCLONE_INT_ACK_SPURIOUS -2\r
103\r
104\r
6003a768 105#ifdef __cplusplus\r
106} // End of extern "C"\r
107#endif\r
d9d77995 108\r
109#endif // __CYCLONE_H__\r
110\r