clarify PicoDrive's license
[picodrive.git] / pico / pico.c
1 /*\r
2  * PicoDrive\r
3  * (c) Copyright Dave, 2004\r
4  * (C) notaz, 2006-2010\r
5  *\r
6  * This work is licensed under the terms of MAME license.\r
7  * See COPYING file in the top-level directory.\r
8  */\r
9 \r
10 #include "pico_int.h"\r
11 #include "sound/ym2612.h"\r
12 \r
13 struct Pico Pico;\r
14 int PicoOpt;     \r
15 int PicoSkipFrame;     // skip rendering frame?\r
16 int PicoPad[2];        // Joypads, format is MXYZ SACB RLDU\r
17 int PicoPadInt[2];     // internal copy\r
18 int PicoAHW;           // active addon hardware: PAHW_*\r
19 int PicoRegionOverride; // override the region detection 0: Auto, 1: Japan NTSC, 2: Japan PAL, 4: US, 8: Europe\r
20 int PicoAutoRgnOrder;\r
21 \r
22 struct PicoSRAM SRam;\r
23 int emustatus;         // rapid_ym2612, multi_ym_updates\r
24 int scanlines_total;\r
25 \r
26 int p32x_msh2_multiplier = MSH2_MULTI_DEFAULT;\r
27 int p32x_ssh2_multiplier = SSH2_MULTI_DEFAULT;\r
28 \r
29 void (*PicoWriteSound)(int len) = NULL; // called at the best time to send sound buffer (PsndOut) to hardware\r
30 void (*PicoResetHook)(void) = NULL;\r
31 void (*PicoLineHook)(void) = NULL;\r
32 \r
33 // to be called once on emu init\r
34 void PicoInit(void)\r
35 {\r
36   // Blank space for state:\r
37   memset(&Pico,0,sizeof(Pico));\r
38   memset(&PicoPad,0,sizeof(PicoPad));\r
39   memset(&PicoPadInt,0,sizeof(PicoPadInt));\r
40 \r
41   // Init CPUs:\r
42   SekInit();\r
43   z80_init(); // init even if we aren't going to use it\r
44 \r
45   PicoInitMCD();\r
46   PicoSVPInit();\r
47   Pico32xInit();\r
48 }\r
49 \r
50 // to be called once on emu exit\r
51 void PicoExit(void)\r
52 {\r
53   if (PicoAHW & PAHW_MCD)\r
54     PicoExitMCD();\r
55   PicoCartUnload();\r
56   z80_exit();\r
57 \r
58   if (SRam.data)\r
59     free(SRam.data);\r
60 }\r
61 \r
62 void PicoPower(void)\r
63 {\r
64   Pico.m.frame_count = 0;\r
65 \r
66   // clear all memory of the emulated machine\r
67   memset(&Pico.ram,0,(unsigned char *)&Pico.rom - Pico.ram);\r
68 \r
69   memset(&Pico.video,0,sizeof(Pico.video));\r
70   memset(&Pico.m,0,sizeof(Pico.m));\r
71 \r
72   Pico.video.pending_ints=0;\r
73   z80_reset();\r
74 \r
75   // default VDP register values (based on Fusion)\r
76   Pico.video.reg[0] = Pico.video.reg[1] = 0x04;\r
77   Pico.video.reg[0xc] = 0x81;\r
78   Pico.video.reg[0xf] = 0x02;\r
79 \r
80   if (PicoAHW & PAHW_MCD)\r
81     PicoPowerMCD();\r
82 \r
83   if (PicoOpt & POPT_EN_32X)\r
84     PicoPower32x();\r
85 \r
86   PicoReset();\r
87 }\r
88 \r
89 PICO_INTERNAL void PicoDetectRegion(void)\r
90 {\r
91   int support=0, hw=0, i;\r
92   unsigned char pal=0;\r
93 \r
94   if (PicoRegionOverride)\r
95   {\r
96     support = PicoRegionOverride;\r
97   }\r
98   else\r
99   {\r
100     // Read cartridge region data:\r
101     unsigned short *rd = (unsigned short *)(Pico.rom + 0x1f0);\r
102     int region = (rd[0] << 16) | rd[1];\r
103 \r
104     for (i = 0; i < 4; i++)\r
105     {\r
106       int c;\r
107 \r
108       c = region >> (i<<3);\r
109       c &= 0xff;\r
110       if (c <= ' ') continue;\r
111 \r
112            if (c=='J')  support|=1;\r
113       else if (c=='U')  support|=4;\r
114       else if (c=='E')  support|=8;\r
115       else if (c=='j') {support|=1; break; }\r
116       else if (c=='u') {support|=4; break; }\r
117       else if (c=='e') {support|=8; break; }\r
118       else\r
119       {\r
120         // New style code:\r
121         char s[2]={0,0};\r
122         s[0]=(char)c;\r
123         support|=strtol(s,NULL,16);\r
124       }\r
125     }\r
126   }\r
127 \r
128   // auto detection order override\r
129   if (PicoAutoRgnOrder) {\r
130          if (((PicoAutoRgnOrder>>0)&0xf) & support) support = (PicoAutoRgnOrder>>0)&0xf;\r
131     else if (((PicoAutoRgnOrder>>4)&0xf) & support) support = (PicoAutoRgnOrder>>4)&0xf;\r
132     else if (((PicoAutoRgnOrder>>8)&0xf) & support) support = (PicoAutoRgnOrder>>8)&0xf;\r
133   }\r
134 \r
135   // Try to pick the best hardware value for English/50hz:\r
136        if (support&8) { hw=0xc0; pal=1; } // Europe\r
137   else if (support&4)   hw=0x80;          // USA\r
138   else if (support&2) { hw=0x40; pal=1; } // Japan PAL\r
139   else if (support&1)   hw=0x00;          // Japan NTSC\r
140   else hw=0x80; // USA\r
141 \r
142   Pico.m.hardware=(unsigned char)(hw|0x20); // No disk attached\r
143   Pico.m.pal=pal;\r
144 }\r
145 \r
146 int PicoReset(void)\r
147 {\r
148   if (Pico.romsize <= 0)\r
149     return 1;\r
150 \r
151   /* must call now, so that banking is reset, and correct vectors get fetched */\r
152   if (PicoResetHook)\r
153     PicoResetHook();\r
154 \r
155   memset(&PicoPadInt,0,sizeof(PicoPadInt));\r
156   emustatus = 0;\r
157 \r
158   if (PicoAHW & PAHW_SMS) {\r
159     PicoResetMS();\r
160     return 0;\r
161   }\r
162 \r
163   SekReset();\r
164   // s68k doesn't have the TAS quirk, so we just globally set normal TAS handler in MCD mode (used by Batman games).\r
165   SekSetRealTAS(PicoAHW & PAHW_MCD);\r
166   SekCycleCntT=0;\r
167 \r
168   if (PicoAHW & PAHW_MCD)\r
169     // needed for MCD to reset properly, probably some bug hides behind this..\r
170     memset(Pico.ioports,0,sizeof(Pico.ioports));\r
171 \r
172   Pico.m.dirtyPal = 1;\r
173 \r
174   Pico.m.z80_bank68k = 0;\r
175   Pico.m.z80_reset = 1;\r
176   memset(Pico.zram, 0, sizeof(Pico.zram)); // ??\r
177 \r
178   PicoDetectRegion();\r
179   Pico.video.status = 0x3428 | Pico.m.pal; // 'always set' bits | vblank | collision | pal\r
180 \r
181   PsndReset(); // pal must be known here\r
182 \r
183   // create an empty "dma" to cause 68k exec start at random frame location\r
184   if (Pico.m.dma_xfers == 0 && !(PicoOpt & POPT_DIS_VDP_FIFO))\r
185     Pico.m.dma_xfers = rand() & 0x1fff;\r
186 \r
187   SekFinishIdleDet();\r
188 \r
189   if (PicoAHW & PAHW_MCD) {\r
190     PicoResetMCD();\r
191     return 0;\r
192   }\r
193 \r
194   // reinit, so that checksum checks pass\r
195   if (!(PicoOpt & POPT_DIS_IDLE_DET))\r
196     SekInitIdleDet();\r
197 \r
198   if (PicoOpt & POPT_EN_32X)\r
199     PicoReset32x();\r
200 \r
201   // reset sram state; enable sram access by default if it doesn't overlap with ROM\r
202   Pico.m.sram_reg = 0;\r
203   if ((SRam.flags & SRF_EEPROM) || Pico.romsize <= SRam.start)\r
204     Pico.m.sram_reg |= SRR_MAPPED;\r
205 \r
206   if (SRam.flags & SRF_ENABLED)\r
207     elprintf(EL_STATUS, "sram: %06x - %06x; eeprom: %i", SRam.start, SRam.end,\r
208       !!(SRam.flags & SRF_EEPROM));\r
209 \r
210   return 0;\r
211 }\r
212 \r
213 // flush config changes before emu loop starts\r
214 void PicoLoopPrepare(void)\r
215 {\r
216   if (PicoRegionOverride)\r
217     // force setting possibly changed..\r
218     Pico.m.pal = (PicoRegionOverride == 2 || PicoRegionOverride == 8) ? 1 : 0;\r
219 \r
220   // FIXME: PAL has 313 scanlines..\r
221   scanlines_total = Pico.m.pal ? 312 : 262;\r
222 \r
223   if (PicoAHW & PAHW_32X)\r
224     p32x_timers_recalc();\r
225 }\r
226 \r
227 \r
228 // dma2vram settings are just hacks to unglitch Legend of Galahad (needs <= 104 to work)\r
229 // same for Outrunners (92-121, when active is set to 24)\r
230 // 96 is VR hack\r
231 static const int dma_timings[] = {\r
232   96,  167, 166,  83, // vblank: 32cell: dma2vram dma2[vs|c]ram vram_fill vram_copy\r
233   102, 205, 204, 102, // vblank: 40cell:\r
234   16,   16,  15,   8, // active: 32cell:\r
235   24,   18,  17,   9  // ...\r
236 };\r
237 \r
238 static const int dma_bsycles[] = {\r
239   (488<<8)/96,  (488<<8)/167, (488<<8)/166, (488<<8)/83,\r
240   (488<<8)/102, (488<<8)/205, (488<<8)/204, (488<<8)/102,\r
241   (488<<8)/16,  (488<<8)/16,  (488<<8)/15,  (488<<8)/8,\r
242   (488<<8)/24,  (488<<8)/18,  (488<<8)/17,  (488<<8)/9\r
243 };\r
244 \r
245 PICO_INTERNAL int CheckDMA(void)\r
246 {\r
247   int burn = 0, xfers_can, dma_op = Pico.video.reg[0x17]>>6; // see gens for 00 and 01 modes\r
248   int xfers = Pico.m.dma_xfers;\r
249   int dma_op1;\r
250 \r
251   if(!(dma_op&2)) dma_op = (Pico.video.type==1) ? 0 : 1; // setting dma_timings offset here according to Gens\r
252   dma_op1 = dma_op;\r
253   if(Pico.video.reg[12] & 1) dma_op |= 4; // 40 cell mode?\r
254   if(!(Pico.video.status&8)&&(Pico.video.reg[1]&0x40)) dma_op|=8; // active display?\r
255   xfers_can = dma_timings[dma_op];\r
256   if(xfers <= xfers_can)\r
257   {\r
258     if(dma_op&2) Pico.video.status&=~2; // dma no longer busy\r
259     else {\r
260       burn = xfers * dma_bsycles[dma_op] >> 8; // have to be approximate because can't afford division..\r
261     }\r
262     Pico.m.dma_xfers = 0;\r
263   } else {\r
264     if(!(dma_op&2)) burn = 488;\r
265     Pico.m.dma_xfers -= xfers_can;\r
266   }\r
267 \r
268   elprintf(EL_VDPDMA, "~Dma %i op=%i can=%i burn=%i [%i]", Pico.m.dma_xfers, dma_op1, xfers_can, burn, SekCyclesDone());\r
269   //dprintf("~aim: %i, cnt: %i", SekCycleAim, SekCycleCnt);\r
270   return burn;\r
271 }\r
272 \r
273 static __inline void SekRunM68k(int cyc)\r
274 {\r
275   int cyc_do;\r
276   pprof_start(m68k);\r
277 \r
278   SekCycleAim+=cyc;\r
279   if ((cyc_do=SekCycleAim-SekCycleCnt) <= 0) return;\r
280 #if defined(EMU_CORE_DEBUG)\r
281   // this means we do run-compare\r
282   SekCycleCnt+=CM_compareRun(cyc_do, 0);\r
283 #elif defined(EMU_C68K)\r
284   PicoCpuCM68k.cycles=cyc_do;\r
285   CycloneRun(&PicoCpuCM68k);\r
286   SekCycleCnt+=cyc_do-PicoCpuCM68k.cycles;\r
287 #elif defined(EMU_M68K)\r
288   SekCycleCnt+=m68k_execute(cyc_do);\r
289 #elif defined(EMU_F68K)\r
290   SekCycleCnt+=fm68k_emulate(cyc_do+1, 0, 0);\r
291 #endif\r
292 \r
293   pprof_end(m68k);\r
294 }\r
295 \r
296 #include "pico_cmn.c"\r
297 \r
298 int z80stopCycle;\r
299 int z80_cycle_cnt;        /* 'done' z80 cycles before z80_run() */\r
300 int z80_cycle_aim;\r
301 int z80_scanline;\r
302 int z80_scanline_cycles;  /* cycles done until z80_scanline */\r
303 \r
304 /* sync z80 to 68k */\r
305 PICO_INTERNAL void PicoSyncZ80(int m68k_cycles_done)\r
306 {\r
307   int cnt;\r
308   z80_cycle_aim = cycles_68k_to_z80(m68k_cycles_done);\r
309   cnt = z80_cycle_aim - z80_cycle_cnt;\r
310 \r
311   pprof_start(z80);\r
312 \r
313   elprintf(EL_BUSREQ, "z80 sync %i (%i|%i -> %i|%i)", cnt, z80_cycle_cnt, z80_cycle_cnt / 228,\r
314     z80_cycle_aim, z80_cycle_aim / 228);\r
315 \r
316   if (cnt > 0)\r
317     z80_cycle_cnt += z80_run(cnt);\r
318 \r
319   pprof_end(z80);\r
320 }\r
321 \r
322 \r
323 void PicoFrame(void)\r
324 {\r
325   pprof_start(frame);\r
326 \r
327   Pico.m.frame_count++;\r
328 \r
329   if (PicoAHW & PAHW_SMS) {\r
330     PicoFrameMS();\r
331     goto end;\r
332   }\r
333 \r
334   // TODO: MCD+32X\r
335   if (PicoAHW & PAHW_MCD) {\r
336     PicoFrameMCD();\r
337     goto end;\r
338   }\r
339 \r
340   if (PicoAHW & PAHW_32X) {\r
341     PicoFrame32x();\r
342     goto end;\r
343   }\r
344 \r
345   //if(Pico.video.reg[12]&0x2) Pico.video.status ^= 0x10; // change odd bit in interlace mode\r
346 \r
347   PicoFrameStart();\r
348   PicoFrameHints();\r
349 \r
350 end:\r
351   pprof_end(frame);\r
352 }\r
353 \r
354 void PicoFrameDrawOnly(void)\r
355 {\r
356   if (!(PicoAHW & PAHW_SMS)) {\r
357     PicoFrameStart();\r
358     PicoDrawSync(223, 0);\r
359   } else {\r
360     PicoFrameDrawOnlyMS();\r
361   }\r
362 }\r
363 \r
364 void PicoGetInternal(pint_t which, pint_ret_t *r)\r
365 {\r
366   switch (which)\r
367   {\r
368     case PI_ROM:         r->vptr = Pico.rom; break;\r
369     case PI_ISPAL:       r->vint = Pico.m.pal; break;\r
370     case PI_IS40_CELL:   r->vint = Pico.video.reg[12]&1; break;\r
371     case PI_IS240_LINES: r->vint = Pico.m.pal && (Pico.video.reg[1]&8); break;\r
372   }\r
373 }\r
374 \r
375 // callback to output message from emu\r
376 void (*PicoMessage)(const char *msg)=NULL;\r
377 \r