bugfixes, adjusted famec timing
[picodrive.git] / Pico / PicoInt.h
1 // Pico Library - Internal Header File\r
2 \r
3 // (c) Copyright 2004 Dave, All rights reserved.\r
4 // (c) Copyright 2006,2007 Grazvydas "notaz" Ignotas, all rights reserved.\r
5 // Free for non-commercial use.\r
6 \r
7 // For commercial use, separate licencing terms must be obtained.\r
8 \r
9 #ifndef PICO_INTERNAL_INCLUDED\r
10 #define PICO_INTERNAL_INCLUDED\r
11 \r
12 #include <stdio.h>\r
13 #include <stdlib.h>\r
14 #include <string.h>\r
15 #include "Pico.h"\r
16 \r
17 //\r
18 #define USE_POLL_DETECT\r
19 \r
20 #ifndef PICO_INTERNAL\r
21 #define PICO_INTERNAL\r
22 #endif\r
23 #ifndef PICO_INTERNAL_ASM\r
24 #define PICO_INTERNAL_ASM\r
25 #endif\r
26 \r
27 // to select core, define EMU_C68K, EMU_M68K or EMU_F68K in your makefile or project\r
28 \r
29 #ifdef __cplusplus\r
30 extern "C" {\r
31 #endif\r
32 \r
33 \r
34 // ----------------------- 68000 CPU -----------------------\r
35 #ifdef EMU_C68K\r
36 #include "../cpu/Cyclone/Cyclone.h"\r
37 extern struct Cyclone PicoCpuCM68k, PicoCpuCS68k;\r
38 #define SekCyclesLeftNoMCD PicoCpuCM68k.cycles // cycles left for this run\r
39 #define SekCyclesLeft \\r
40         (((PicoMCD&1) && (PicoOpt & 0x2000)) ? (SekCycleAim-SekCycleCnt) : SekCyclesLeftNoMCD)\r
41 #define SekCyclesLeftS68k \\r
42         ((PicoOpt & 0x2000) ? (SekCycleAimS68k-SekCycleCntS68k) : PicoCpuCS68k.cycles)\r
43 #define SekSetCyclesLeftNoMCD(c) PicoCpuCM68k.cycles=c\r
44 #define SekSetCyclesLeft(c) { \\r
45         if ((PicoMCD&1) && (PicoOpt & 0x2000)) SekCycleCnt=SekCycleAim-(c); else SekSetCyclesLeftNoMCD(c); \\r
46 }\r
47 #define SekPc (PicoCpuCM68k.pc-PicoCpuCM68k.membase)\r
48 #define SekPcS68k (PicoCpuCS68k.pc-PicoCpuCS68k.membase)\r
49 #define SekSetStop(x) { PicoCpuCM68k.state_flags&=~1; if (x) { PicoCpuCM68k.state_flags|=1; PicoCpuCM68k.cycles=0; } }\r
50 #define SekSetStopS68k(x) { PicoCpuCS68k.state_flags&=~1; if (x) { PicoCpuCS68k.state_flags|=1; PicoCpuCS68k.cycles=0; } }\r
51 #define SekShouldInterrupt (PicoCpuCM68k.irq > (PicoCpuCM68k.srh&7))\r
52 #ifdef EMU_M68K\r
53 #define EMU_CORE_DEBUG\r
54 #endif\r
55 #endif\r
56 \r
57 #ifdef EMU_F68K\r
58 #include "../cpu/fame/fame.h"\r
59 M68K_CONTEXT PicoCpuFM68k, PicoCpuFS68k;\r
60 #define SekCyclesLeftNoMCD PicoCpuFM68k.io_cycle_counter\r
61 #define SekCyclesLeft \\r
62         (((PicoMCD&1) && (PicoOpt & 0x2000)) ? (SekCycleAim-SekCycleCnt) : SekCyclesLeftNoMCD)\r
63 #define SekCyclesLeftS68k \\r
64         ((PicoOpt & 0x2000) ? (SekCycleAimS68k-SekCycleCntS68k) : PicoCpuFS68k.io_cycle_counter)\r
65 #define SekSetCyclesLeftNoMCD(c) PicoCpuFM68k.io_cycle_counter=c\r
66 #define SekSetCyclesLeft(c) { \\r
67         if ((PicoMCD&1) && (PicoOpt & 0x2000)) SekCycleCnt=SekCycleAim-(c); else SekSetCyclesLeftNoMCD(c); \\r
68 }\r
69 #define SekPc     fm68k_get_pc(&PicoCpuFM68k)\r
70 #define SekPcS68k fm68k_get_pc(&PicoCpuFS68k)\r
71 #define SekSetStop(x) { \\r
72         PicoCpuFM68k.execinfo &= ~FM68K_HALTED; \\r
73         if (x) { PicoCpuFM68k.execinfo |= FM68K_HALTED; PicoCpuFM68k.io_cycle_counter = 0; } \\r
74 }\r
75 #define SekSetStopS68k(x) { \\r
76         PicoCpuFS68k.execinfo &= ~FM68K_HALTED; \\r
77         if (x) { PicoCpuFS68k.execinfo |= FM68K_HALTED; PicoCpuFS68k.io_cycle_counter = 0; } \\r
78 }\r
79 #define SekShouldInterrupt fm68k_would_interrupt()\r
80 #ifdef EMU_M68K\r
81 #define EMU_CORE_DEBUG\r
82 #endif\r
83 #endif\r
84 \r
85 #ifdef EMU_M68K\r
86 #include "../cpu/musashi/m68kcpu.h"\r
87 extern m68ki_cpu_core PicoCpuMM68k, PicoCpuMS68k;\r
88 #ifndef SekCyclesLeft\r
89 #define SekCyclesLeftNoMCD PicoCpuMM68k.cyc_remaining_cycles\r
90 #define SekCyclesLeft \\r
91         (((PicoMCD&1) && (PicoOpt & 0x2000)) ? (SekCycleAim-SekCycleCnt) : SekCyclesLeftNoMCD)\r
92 #define SekCyclesLeftS68k \\r
93         ((PicoOpt & 0x2000) ? (SekCycleAimS68k-SekCycleCntS68k) : PicoCpuMS68k.cyc_remaining_cycles)\r
94 #define SekSetCyclesLeftNoMCD(c) SET_CYCLES(c)\r
95 #define SekSetCyclesLeft(c) { \\r
96         if ((PicoMCD&1) && (PicoOpt & 0x2000)) SekCycleCnt=SekCycleAim-(c); else SET_CYCLES(c); \\r
97 }\r
98 #define SekPc m68k_get_reg(&PicoCpuMM68k, M68K_REG_PC)\r
99 #define SekPcS68k m68k_get_reg(&PicoCpuMS68k, M68K_REG_PC)\r
100 #define SekSetStop(x) { \\r
101         if(x) { SET_CYCLES(0); PicoCpuMM68k.stopped=STOP_LEVEL_STOP; } \\r
102         else PicoCpuMM68k.stopped=0; \\r
103 }\r
104 #define SekSetStopS68k(x) { \\r
105         if(x) { SET_CYCLES(0); PicoCpuMS68k.stopped=STOP_LEVEL_STOP; } \\r
106         else PicoCpuMS68k.stopped=0; \\r
107 }\r
108 #define SekShouldInterrupt (CPU_INT_LEVEL > FLAG_INT_MASK)\r
109 #endif\r
110 #endif\r
111 \r
112 extern int SekCycleCnt; // cycles done in this frame\r
113 extern int SekCycleAim; // cycle aim\r
114 extern unsigned int SekCycleCntT; // total cycle counter, updated once per frame\r
115 \r
116 #define SekCyclesReset() { \\r
117         SekCycleCntT+=SekCycleAim; \\r
118         SekCycleCnt-=SekCycleAim; \\r
119         SekCycleAim=0; \\r
120 }\r
121 #define SekCyclesBurn(c)  SekCycleCnt+=c\r
122 #define SekCyclesDone()  (SekCycleAim-SekCyclesLeft)    // nuber of cycles done in this frame (can be checked anywhere)\r
123 #define SekCyclesDoneT() (SekCycleCntT+SekCyclesDone()) // total nuber of cycles done for this rom\r
124 \r
125 #define SekEndRun(after) { \\r
126         SekCycleCnt -= SekCyclesLeft - after; \\r
127         if(SekCycleCnt < 0) SekCycleCnt = 0; \\r
128         SekSetCyclesLeft(after); \\r
129 }\r
130 \r
131 extern int SekCycleCntS68k;\r
132 extern int SekCycleAimS68k;\r
133 \r
134 #define SekCyclesResetS68k() { \\r
135         SekCycleCntS68k-=SekCycleAimS68k; \\r
136         SekCycleAimS68k=0; \\r
137 }\r
138 #define SekCyclesDoneS68k()  (SekCycleAimS68k-SekCyclesLeftS68k)\r
139 \r
140 #ifdef EMU_CORE_DEBUG\r
141 #undef SekSetCyclesLeftNoMCD\r
142 #undef SekSetCyclesLeft\r
143 #undef SekCyclesBurn\r
144 #undef SekEndRun\r
145 #define SekSetCyclesLeftNoMCD(c)\r
146 #define SekSetCyclesLeft(c)\r
147 #define SekCyclesBurn(c) c\r
148 #define SekEndRun(c)\r
149 #endif\r
150 \r
151 // ---------------------------------------------------------\r
152 \r
153 extern int PicoMCD;\r
154 \r
155 // main oscillator clock which controls timing\r
156 #define OSC_NTSC 53693100\r
157 // seems to be accurate, see scans from http://www.hot.ee/tmeeco/\r
158 #define OSC_PAL  53203424\r
159 \r
160 struct PicoVideo\r
161 {\r
162   unsigned char reg[0x20];\r
163   unsigned int command;       // 32-bit Command\r
164   unsigned char pending;      // 1 if waiting for second half of 32-bit command\r
165   unsigned char type;         // Command type (v/c/vsram read/write)\r
166   unsigned short addr;        // Read/Write address\r
167   int status;                 // Status bits\r
168   unsigned char pending_ints; // pending interrupts: ??VH????\r
169   signed char lwrite_cnt;     // VDP write count during active display line\r
170   unsigned char pad[0x12];\r
171 };\r
172 \r
173 struct PicoMisc\r
174 {\r
175   unsigned char rotate;\r
176   unsigned char z80Run;\r
177   unsigned char padTHPhase[2]; // 02 phase of gamepad TH switches\r
178   short scanline;              // 04 0 to 261||311; -1 in fast mode\r
179   char dirtyPal;               // 06 Is the palette dirty (1 - change @ this frame, 2 - some time before)\r
180   unsigned char hardware;      // 07 Hardware value for country\r
181   unsigned char pal;           // 08 1=PAL 0=NTSC\r
182   unsigned char sram_reg;      // SRAM mode register. bit0: allow read? bit1: deny write? bit2: EEPROM? bit4: detected? (header or by access)\r
183   unsigned short z80_bank68k;  // 0a\r
184   unsigned short z80_lastaddr; // this is for Z80 faking\r
185   unsigned char  z80_fakeval;\r
186   unsigned char  pad0;\r
187   unsigned char  padDelay[2];  // 10 gamepad phase time outs, so we count a delay\r
188   unsigned short eeprom_addr;  // EEPROM address register\r
189   unsigned char  eeprom_cycle; // EEPROM SRAM cycle number\r
190   unsigned char  eeprom_slave; // EEPROM slave word for X24C02 and better SRAMs\r
191   unsigned char prot_bytes[2]; // simple protection faking\r
192   unsigned short dma_xfers;\r
193   unsigned char pad[2];\r
194   unsigned int  frame_count; // mainly for movies\r
195 };\r
196 \r
197 // some assembly stuff depend on these, do not touch!\r
198 struct Pico\r
199 {\r
200   unsigned char ram[0x10000];  // 0x00000 scratch ram\r
201   unsigned short vram[0x8000]; // 0x10000\r
202   unsigned char zram[0x2000];  // 0x20000 Z80 ram\r
203   unsigned char ioports[0x10];\r
204   unsigned int pad[0x3c];      // unused\r
205   unsigned short cram[0x40];   // 0x22100\r
206   unsigned short vsram[0x40];  // 0x22180\r
207 \r
208   unsigned char *rom;          // 0x22200\r
209   unsigned int romsize;        // 0x22204\r
210 \r
211   struct PicoMisc m;\r
212   struct PicoVideo video;\r
213 };\r
214 \r
215 // sram\r
216 struct PicoSRAM\r
217 {\r
218   unsigned char *data;          // actual data\r
219   unsigned int start;           // start address in 68k address space\r
220   unsigned int end;\r
221   unsigned char unused1;        // 0c: unused\r
222   unsigned char unused2;\r
223   unsigned char changed;\r
224   unsigned char eeprom_type;    // eeprom type: 0: 7bit (24C01), 2: device with 2 addr words (X24C02+), 3: dev with 3 addr words\r
225   unsigned char eeprom_abits;   // eeprom access must be odd addr for: bit0 ~ cl, bit1 ~ out\r
226   unsigned char eeprom_bit_cl;  // bit number for cl\r
227   unsigned char eeprom_bit_in;  // bit number for in\r
228   unsigned char eeprom_bit_out; // bit number for out\r
229 };\r
230 \r
231 // MCD\r
232 #include "cd/cd_sys.h"\r
233 #include "cd/LC89510.h"\r
234 #include "cd/gfx_cd.h"\r
235 \r
236 struct mcd_pcm\r
237 {\r
238         unsigned char control; // reg7\r
239         unsigned char enabled; // reg8\r
240         unsigned char cur_ch;\r
241         unsigned char bank;\r
242         int pad1;\r
243 \r
244         struct pcm_chan                 // 08, size 0x10\r
245         {\r
246                 unsigned char regs[8];\r
247                 unsigned int  addr;     // .08: played sample address\r
248                 int pad;\r
249         } ch[8];\r
250 };\r
251 \r
252 struct mcd_misc\r
253 {\r
254         unsigned short hint_vector;\r
255         unsigned char  busreq;\r
256         unsigned char  s68k_pend_ints;\r
257         unsigned int   state_flags;     // 04: emu state: reset_pending, dmna_pending\r
258         unsigned int   counter75hz;\r
259         unsigned short audio_offset;    // 0c: for savestates: play pointer offset (0-1023)\r
260         unsigned char  audio_track;     // playing audio track # (zero based)\r
261         char           pad1;\r
262         int            timer_int3;      // 10\r
263         unsigned int   timer_stopwatch;\r
264         unsigned char  bcram_reg;       // 18: battery-backed RAM cart register\r
265         unsigned char  pad2;\r
266         unsigned short pad3;\r
267         int pad[9];\r
268 };\r
269 \r
270 typedef struct\r
271 {\r
272         unsigned char bios[0x20000];                    // 000000: 128K\r
273         union {                                         // 020000: 512K\r
274                 unsigned char prg_ram[0x80000];\r
275                 unsigned char prg_ram_b[4][0x20000];\r
276         };\r
277         union {                                         // 0a0000: 256K\r
278                 struct {\r
279                         unsigned char word_ram2M[0x40000];\r
280                         unsigned char unused[0x20000];\r
281                 };\r
282                 struct {\r
283                         unsigned char unused[0x20000];\r
284                         unsigned char word_ram1M[2][0x20000];\r
285                 };\r
286         };\r
287         union {                                         // 100000: 64K\r
288                 unsigned char pcm_ram[0x10000];\r
289                 unsigned char pcm_ram_b[0x10][0x1000];\r
290         };\r
291         unsigned char s68k_regs[0x200];                 // 110000: GA, not CPU regs\r
292         unsigned char bram[0x2000];                     // 110200: 8K\r
293         struct mcd_misc m;                              // 112200: misc\r
294         struct mcd_pcm pcm;                             // 112240:\r
295         _scd_toc TOC;                                   // not to be saved\r
296         CDD  cdd;\r
297         CDC  cdc;\r
298         _scd scd;\r
299         Rot_Comp rot_comp;\r
300 } mcd_state;\r
301 \r
302 #define Pico_mcd ((mcd_state *)Pico.rom)\r
303 \r
304 // Area.c\r
305 PICO_INTERNAL int PicoAreaPackCpu(unsigned char *cpu, int is_sub);\r
306 PICO_INTERNAL int PicoAreaUnpackCpu(unsigned char *cpu, int is_sub);\r
307 \r
308 // cd/Area.c\r
309 PICO_INTERNAL int PicoCdSaveState(void *file);\r
310 PICO_INTERNAL int PicoCdLoadState(void *file);\r
311 \r
312 // Cart.c\r
313 PICO_INTERNAL void PicoCartDetect(void);\r
314 \r
315 // Debug.c\r
316 int CM_compareRun(int cyc);\r
317 \r
318 // Draw.c\r
319 PICO_INTERNAL int PicoLine(int scan);\r
320 PICO_INTERNAL void PicoFrameStart(void);\r
321 \r
322 // Draw2.c\r
323 PICO_INTERNAL void PicoFrameFull();\r
324 \r
325 // Memory.c\r
326 PICO_INTERNAL int PicoInitPc(unsigned int pc);\r
327 PICO_INTERNAL_ASM unsigned int PicoRead32(unsigned int a);\r
328 PICO_INTERNAL void PicoMemSetup(void);\r
329 PICO_INTERNAL_ASM void PicoMemReset(void);\r
330 PICO_INTERNAL int PadRead(int i);\r
331 PICO_INTERNAL unsigned char z80_read(unsigned short a);\r
332 #ifndef _USE_CZ80\r
333 PICO_INTERNAL_ASM void z80_write(unsigned char data, unsigned short a);\r
334 PICO_INTERNAL void z80_write16(unsigned short data, unsigned short a);\r
335 PICO_INTERNAL unsigned short z80_read16(unsigned short a);\r
336 #else\r
337 PICO_INTERNAL_ASM void z80_write(unsigned int a, unsigned char data);\r
338 #endif\r
339 \r
340 // cd/Memory.c\r
341 PICO_INTERNAL void PicoMemSetupCD(void);\r
342 PICO_INTERNAL_ASM void PicoMemResetCD(int r3);\r
343 PICO_INTERNAL_ASM void PicoMemResetCDdecode(int r3);\r
344 \r
345 // Pico.c\r
346 extern struct Pico Pico;\r
347 extern struct PicoSRAM SRam;\r
348 extern int emustatus;\r
349 extern int z80startCycle, z80stopCycle; // in 68k cycles\r
350 PICO_INTERNAL int CheckDMA(void);\r
351 \r
352 // cd/Pico.c\r
353 PICO_INTERNAL int  PicoInitMCD(void);\r
354 PICO_INTERNAL void PicoExitMCD(void);\r
355 PICO_INTERNAL int PicoResetMCD(int hard);\r
356 PICO_INTERNAL int PicoFrameMCD(void);\r
357 \r
358 // Sek.c\r
359 PICO_INTERNAL int SekInit(void);\r
360 PICO_INTERNAL int SekReset(void);\r
361 PICO_INTERNAL int SekInterrupt(int irq);\r
362 PICO_INTERNAL void SekState(int *data);\r
363 PICO_INTERNAL void SekSetRealTAS(int use_real);\r
364 \r
365 // cd/Sek.c\r
366 PICO_INTERNAL int SekInitS68k(void);\r
367 PICO_INTERNAL int SekResetS68k(void);\r
368 PICO_INTERNAL int SekInterruptS68k(int irq);\r
369 \r
370 // sound/sound.c\r
371 extern int PsndLen_exc_cnt;\r
372 extern int PsndLen_exc_add;\r
373 \r
374 // VideoPort.c\r
375 PICO_INTERNAL_ASM void PicoVideoWrite(unsigned int a,unsigned short d);\r
376 PICO_INTERNAL_ASM unsigned int PicoVideoRead(unsigned int a);\r
377 \r
378 // Misc.c\r
379 PICO_INTERNAL void SRAMWriteEEPROM(unsigned int d);\r
380 PICO_INTERNAL void SRAMUpdPending(unsigned int a, unsigned int d);\r
381 PICO_INTERNAL_ASM unsigned int SRAMReadEEPROM(void);\r
382 PICO_INTERNAL_ASM void memcpy16(unsigned short *dest, unsigned short *src, int count);\r
383 PICO_INTERNAL_ASM void memcpy16bswap(unsigned short *dest, void *src, int count);\r
384 PICO_INTERNAL_ASM void memcpy32(int *dest, int *src, int count); // 32bit word count\r
385 PICO_INTERNAL_ASM void memset32(int *dest, int c, int count);\r
386 \r
387 // cd/Misc.c\r
388 PICO_INTERNAL_ASM void wram_2M_to_1M(unsigned char *m);\r
389 PICO_INTERNAL_ASM void wram_1M_to_2M(unsigned char *m);\r
390 \r
391 // cd/buffering.c\r
392 PICO_INTERNAL void PicoCDBufferRead(void *dest, int lba);\r
393 \r
394 // sound/sound.c\r
395 PICO_INTERNAL void sound_reset(void);\r
396 PICO_INTERNAL void sound_timers_and_dac(int raster);\r
397 PICO_INTERNAL int  sound_render(int offset, int length);\r
398 PICO_INTERNAL void sound_clear(void);\r
399 // z80 functionality wrappers\r
400 PICO_INTERNAL void z80_init(void);\r
401 PICO_INTERNAL void z80_resetCycles(void);\r
402 PICO_INTERNAL void z80_int(void);\r
403 PICO_INTERNAL int  z80_run(int cycles);\r
404 PICO_INTERNAL void z80_pack(unsigned char *data);\r
405 PICO_INTERNAL void z80_unpack(unsigned char *data);\r
406 PICO_INTERNAL void z80_reset(void);\r
407 PICO_INTERNAL void z80_exit(void);\r
408 \r
409 \r
410 #ifdef __cplusplus\r
411 } // End of extern "C"\r
412 #endif\r
413 \r
414 // emulation event logging\r
415 #ifndef EL_LOGMASK\r
416 #define EL_LOGMASK 0\r
417 #endif\r
418 \r
419 #define EL_HVCNT   0x0001 /* hv counter reads */\r
420 #define EL_SR      0x0002 /* SR reads */\r
421 #define EL_INTS    0x0004 /* ints and acks */\r
422 #define EL_YM2612R 0x0008 /* 68k ym2612 reads */\r
423 #define EL_INTSW   0x0010 /* log irq switching on/off */\r
424 #define EL_ASVDP   0x0020 /* VDP accesses during active scan */\r
425 #define EL_VDPDMA  0x0040 /* VDP DMA transfers and their timing */\r
426 #define EL_BUSREQ  0x0080 /* z80 busreq r/w or reset w */\r
427 #define EL_Z80BNK  0x0100 /* z80 i/o through bank area */\r
428 #define EL_SRAMIO  0x0200 /* sram i/o */\r
429 #define EL_EEPROM  0x0400 /* eeprom debug */\r
430 #define EL_UIO     0x0800 /* unmapped i/o */\r
431 #define EL_IO      0x1000 /* all i/o (TODO) */\r
432 \r
433 #define EL_STATUS  0x4000 /* status messages */\r
434 #define EL_ANOMALY 0x8000 /* some unexpected conditions */\r
435 \r
436 #if EL_LOGMASK\r
437 #define elprintf(w,f,...) \\r
438 { \\r
439         if ((w) & EL_LOGMASK) \\r
440                 printf("%05i:%03i: " f "\n",Pico.m.frame_count,Pico.m.scanline,##__VA_ARGS__); \\r
441 }\r
442 #else\r
443 #define elprintf(w,f,...)\r
444 #endif\r
445 \r
446 #endif // PICO_INTERNAL_INCLUDED\r
447 \r