some uncommitted old mapper code
[picodrive.git] / pico / cart.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 "../zlib/zlib.h"\r
12 #include "../cpu/debug.h"\r
13 #include "../unzip/unzip.h"\r
14 #include "../unzip/unzip_stream.h"\r
15 \r
16 \r
17 static int rom_alloc_size;\r
18 static const char *rom_exts[] = { "bin", "gen", "smd", "iso", "sms", "gg", "sg" };\r
19 \r
20 void (*PicoCartUnloadHook)(void);\r
21 void (*PicoCartMemSetup)(void);\r
22 \r
23 void (*PicoCartLoadProgressCB)(int percent) = NULL;\r
24 void (*PicoCDLoadProgressCB)(const char *fname, int percent) = NULL; // handled in Pico/cd/cd_file.c\r
25 \r
26 static void PicoCartDetect(const char *carthw_cfg);\r
27 \r
28 /* cso struct */\r
29 typedef struct _cso_struct\r
30 {\r
31   unsigned char in_buff[2*2048];\r
32   unsigned char out_buff[2048];\r
33   struct {\r
34     char          magic[4];\r
35     unsigned int  unused;\r
36     unsigned int  total_bytes;\r
37     unsigned int  total_bytes_high; // ignored here\r
38     unsigned int  block_size;  // 10h\r
39     unsigned char ver;\r
40     unsigned char align;\r
41     unsigned char reserved[2];\r
42   } header;\r
43   unsigned int  fpos_in;  // input file read pointer\r
44   unsigned int  fpos_out; // pos in virtual decompressed file\r
45   int block_in_buff;      // block which we have read in in_buff\r
46   int pad;\r
47   int index[0];\r
48 }\r
49 cso_struct;\r
50 \r
51 static int uncompress2(void *dest, int destLen, void *source, int sourceLen)\r
52 {\r
53     z_stream stream;\r
54     int err;\r
55 \r
56     stream.next_in = (Bytef*)source;\r
57     stream.avail_in = (uInt)sourceLen;\r
58     stream.next_out = dest;\r
59     stream.avail_out = (uInt)destLen;\r
60 \r
61     stream.zalloc = NULL;\r
62     stream.zfree = NULL;\r
63 \r
64     err = inflateInit2(&stream, -15);\r
65     if (err != Z_OK) return err;\r
66 \r
67     err = inflate(&stream, Z_FINISH);\r
68     if (err != Z_STREAM_END) {\r
69         inflateEnd(&stream);\r
70         return err;\r
71     }\r
72     //*destLen = stream.total_out;\r
73 \r
74     return inflateEnd(&stream);\r
75 }\r
76 \r
77 static const char *get_ext(const char *path)\r
78 {\r
79   const char *ext;\r
80   if (strlen(path) < 4)\r
81     return ""; // no ext\r
82 \r
83   // allow 2 or 3 char extensions for now\r
84   ext = path + strlen(path) - 2;\r
85   if (ext[-1] != '.') ext--;\r
86   if (ext[-1] != '.')\r
87     return "";\r
88   return ext;\r
89 }\r
90 \r
91 pm_file *pm_open(const char *path)\r
92 {\r
93   pm_file *file = NULL;\r
94   const char *ext;\r
95   FILE *f;\r
96 \r
97   if (path == NULL)\r
98     return NULL;\r
99 \r
100   ext = get_ext(path);\r
101   if (strcasecmp(ext, "zip") == 0)\r
102   {\r
103     struct zipent *zipentry;\r
104     gzFile gzf = NULL;\r
105     ZIP *zipfile;\r
106     int i;\r
107 \r
108     zipfile = openzip(path);\r
109     if (zipfile != NULL)\r
110     {\r
111       /* search for suitable file (right extension or large enough file) */\r
112       while ((zipentry = readzip(zipfile)) != NULL)\r
113       {\r
114         ext = get_ext(zipentry->name);\r
115 \r
116         if (zipentry->uncompressed_size >= 32*1024)\r
117           goto found_rom_zip;\r
118 \r
119         for (i = 0; i < sizeof(rom_exts)/sizeof(rom_exts[0]); i++)\r
120           if (strcasecmp(ext, rom_exts[i]) == 0)\r
121             goto found_rom_zip;\r
122       }\r
123 \r
124       /* zipfile given, but nothing found suitable for us inside */\r
125       goto zip_failed;\r
126 \r
127 found_rom_zip:\r
128       /* try to convert to gzip stream, so we could use standard gzio functions from zlib */\r
129       gzf = zip2gz(zipfile, zipentry);\r
130       if (gzf == NULL)  goto zip_failed;\r
131 \r
132       file = calloc(1, sizeof(*file));\r
133       if (file == NULL) goto zip_failed;\r
134       file->file  = zipfile;\r
135       file->param = gzf;\r
136       file->size  = zipentry->uncompressed_size;\r
137       file->type  = PMT_ZIP;\r
138       strncpy(file->ext, ext, sizeof(file->ext) - 1);\r
139       return file;\r
140 \r
141 zip_failed:\r
142       if (gzf) {\r
143         gzclose(gzf);\r
144         zipfile->fp = NULL; // gzclose() closed it\r
145       }\r
146       closezip(zipfile);\r
147       return NULL;\r
148     }\r
149   }\r
150   else if (strcasecmp(ext, "cso") == 0)\r
151   {\r
152     cso_struct *cso = NULL, *tmp = NULL;\r
153     int size;\r
154     f = fopen(path, "rb");\r
155     if (f == NULL)\r
156       goto cso_failed;\r
157 \r
158 #ifndef __EPOC32__\r
159     /* we use our own buffering */\r
160     setvbuf(f, NULL, _IONBF, 0);\r
161 #endif\r
162 \r
163     cso = malloc(sizeof(*cso));\r
164     if (cso == NULL)\r
165       goto cso_failed;\r
166 \r
167     if (fread(&cso->header, 1, sizeof(cso->header), f) != sizeof(cso->header))\r
168       goto cso_failed;\r
169 \r
170     if (strncmp(cso->header.magic, "CISO", 4) != 0) {\r
171       elprintf(EL_STATUS, "cso: bad header");\r
172       goto cso_failed;\r
173     }\r
174 \r
175     if (cso->header.block_size != 2048) {\r
176       elprintf(EL_STATUS, "cso: bad block size (%u)", cso->header.block_size);\r
177       goto cso_failed;\r
178     }\r
179 \r
180     size = ((cso->header.total_bytes >> 11) + 1)*4 + sizeof(*cso);\r
181     tmp = realloc(cso, size);\r
182     if (tmp == NULL)\r
183       goto cso_failed;\r
184     cso = tmp;\r
185     elprintf(EL_STATUS, "allocated %i bytes for CSO struct", size);\r
186 \r
187     size -= sizeof(*cso); // index size\r
188     if (fread(cso->index, 1, size, f) != size) {\r
189       elprintf(EL_STATUS, "cso: premature EOF");\r
190       goto cso_failed;\r
191     }\r
192 \r
193     // all ok\r
194     cso->fpos_in = ftell(f);\r
195     cso->fpos_out = 0;\r
196     cso->block_in_buff = -1;\r
197     file = calloc(1, sizeof(*file));\r
198     if (file == NULL) goto cso_failed;\r
199     file->file  = f;\r
200     file->param = cso;\r
201     file->size  = cso->header.total_bytes;\r
202     file->type  = PMT_CSO;\r
203     return file;\r
204 \r
205 cso_failed:\r
206     if (cso != NULL) free(cso);\r
207     if (f != NULL) fclose(f);\r
208     return NULL;\r
209   }\r
210 \r
211   /* not a zip, treat as uncompressed file */\r
212   f = fopen(path, "rb");\r
213   if (f == NULL) return NULL;\r
214 \r
215   file = calloc(1, sizeof(*file));\r
216   if (file == NULL) {\r
217     fclose(f);\r
218     return NULL;\r
219   }\r
220   fseek(f, 0, SEEK_END);\r
221   file->file  = f;\r
222   file->param = NULL;\r
223   file->size  = ftell(f);\r
224   file->type  = PMT_UNCOMPRESSED;\r
225   strncpy(file->ext, ext, sizeof(file->ext) - 1);\r
226   fseek(f, 0, SEEK_SET);\r
227 \r
228 #ifndef __EPOC32__ // makes things worse on Symbian\r
229   if (file->size > 0x400000)\r
230     /* we use our own buffering */\r
231     setvbuf(f, NULL, _IONBF, 0);\r
232 #endif\r
233 \r
234   return file;\r
235 }\r
236 \r
237 size_t pm_read(void *ptr, size_t bytes, pm_file *stream)\r
238 {\r
239   int ret;\r
240 \r
241   if (stream->type == PMT_UNCOMPRESSED)\r
242   {\r
243     ret = fread(ptr, 1, bytes, stream->file);\r
244   }\r
245   else if (stream->type == PMT_ZIP)\r
246   {\r
247     gzFile gf = stream->param;\r
248     int err;\r
249     ret = gzread(gf, ptr, bytes);\r
250     err = gzerror2(gf);\r
251     if (ret > 0 && (err == Z_DATA_ERROR || err == Z_STREAM_END))\r
252       /* we must reset stream pointer or else next seek/read fails */\r
253       gzrewind(gf);\r
254   }\r
255   else if (stream->type == PMT_CSO)\r
256   {\r
257     cso_struct *cso = stream->param;\r
258     int read_pos, read_len, out_offs, rret;\r
259     int block = cso->fpos_out >> 11;\r
260     int index = cso->index[block];\r
261     int index_end = cso->index[block+1];\r
262     unsigned char *out = ptr, *tmp_dst;\r
263 \r
264     ret = 0;\r
265     while (bytes != 0)\r
266     {\r
267       out_offs = cso->fpos_out&0x7ff;\r
268       if (out_offs == 0 && bytes >= 2048)\r
269            tmp_dst = out;\r
270       else tmp_dst = cso->out_buff;\r
271 \r
272       read_pos = (index&0x7fffffff) << cso->header.align;\r
273 \r
274       if (index < 0) {\r
275         if (read_pos != cso->fpos_in)\r
276           fseek(stream->file, read_pos, SEEK_SET);\r
277         rret = fread(tmp_dst, 1, 2048, stream->file);\r
278         cso->fpos_in = read_pos + rret;\r
279         if (rret != 2048) break;\r
280       } else {\r
281         read_len = (((index_end&0x7fffffff) << cso->header.align) - read_pos) & 0xfff;\r
282         if (block != cso->block_in_buff)\r
283         {\r
284           if (read_pos != cso->fpos_in)\r
285             fseek(stream->file, read_pos, SEEK_SET);\r
286           rret = fread(cso->in_buff, 1, read_len, stream->file);\r
287           cso->fpos_in = read_pos + rret;\r
288           if (rret != read_len) {\r
289             elprintf(EL_STATUS, "cso: read failed @ %08x", read_pos);\r
290             break;\r
291           }\r
292           cso->block_in_buff = block;\r
293         }\r
294         rret = uncompress2(tmp_dst, 2048, cso->in_buff, read_len);\r
295         if (rret != 0) {\r
296           elprintf(EL_STATUS, "cso: uncompress failed @ %08x with %i", read_pos, rret);\r
297           break;\r
298         }\r
299       }\r
300 \r
301       rret = 2048;\r
302       if (out_offs != 0 || bytes < 2048) {\r
303         //elprintf(EL_STATUS, "cso: unaligned/nonfull @ %08x, offs=%i, len=%u", cso->fpos_out, out_offs, bytes);\r
304         if (bytes < rret) rret = bytes;\r
305         if (2048 - out_offs < rret) rret = 2048 - out_offs;\r
306         memcpy(out, tmp_dst + out_offs, rret);\r
307       }\r
308       ret += rret;\r
309       out += rret;\r
310       cso->fpos_out += rret;\r
311       bytes -= rret;\r
312       block++;\r
313       index = index_end;\r
314       index_end = cso->index[block+1];\r
315     }\r
316   }\r
317   else\r
318     ret = 0;\r
319 \r
320   return ret;\r
321 }\r
322 \r
323 int pm_seek(pm_file *stream, long offset, int whence)\r
324 {\r
325   if (stream->type == PMT_UNCOMPRESSED)\r
326   {\r
327     fseek(stream->file, offset, whence);\r
328     return ftell(stream->file);\r
329   }\r
330   else if (stream->type == PMT_ZIP)\r
331   {\r
332     if (PicoMessage != NULL && offset > 6*1024*1024) {\r
333       long pos = gztell((gzFile) stream->param);\r
334       if (offset < pos || offset - pos > 6*1024*1024)\r
335         PicoMessage("Decompressing data...");\r
336     }\r
337     return gzseek((gzFile) stream->param, offset, whence);\r
338   }\r
339   else if (stream->type == PMT_CSO)\r
340   {\r
341     cso_struct *cso = stream->param;\r
342     switch (whence)\r
343     {\r
344       case SEEK_CUR: cso->fpos_out += offset; break;\r
345       case SEEK_SET: cso->fpos_out  = offset; break;\r
346       case SEEK_END: cso->fpos_out  = cso->header.total_bytes - offset; break;\r
347     }\r
348     return cso->fpos_out;\r
349   }\r
350   else\r
351     return -1;\r
352 }\r
353 \r
354 int pm_close(pm_file *fp)\r
355 {\r
356   int ret = 0;\r
357 \r
358   if (fp == NULL) return EOF;\r
359 \r
360   if (fp->type == PMT_UNCOMPRESSED)\r
361   {\r
362     fclose(fp->file);\r
363   }\r
364   else if (fp->type == PMT_ZIP)\r
365   {\r
366     ZIP *zipfile = fp->file;\r
367     gzclose((gzFile) fp->param);\r
368     zipfile->fp = NULL; // gzclose() closed it\r
369     closezip(zipfile);\r
370   }\r
371   else if (fp->type == PMT_CSO)\r
372   {\r
373     free(fp->param);\r
374     fclose(fp->file);\r
375   }\r
376   else\r
377     ret = EOF;\r
378 \r
379   free(fp);\r
380   return ret;\r
381 }\r
382 \r
383 // byteswap, data needs to be int aligned, src can match dst\r
384 void Byteswap(void *dst, const void *src, int len)\r
385 {\r
386   const unsigned int *ps = src;\r
387   unsigned int *pd = dst;\r
388   int i, m;\r
389 \r
390   if (len < 2)\r
391     return;\r
392 \r
393   m = 0x00ff00ff;\r
394   for (i = 0; i < len / 4; i++) {\r
395     unsigned int t = ps[i];\r
396     pd[i] = ((t & m) << 8) | ((t & ~m) >> 8);\r
397   }\r
398 }\r
399 \r
400 // Interleve a 16k block and byteswap\r
401 static int InterleveBlock(unsigned char *dest,unsigned char *src)\r
402 {\r
403   int i=0;\r
404   for (i=0;i<0x2000;i++) dest[(i<<1)  ]=src[       i]; // Odd\r
405   for (i=0;i<0x2000;i++) dest[(i<<1)+1]=src[0x2000+i]; // Even\r
406   return 0;\r
407 }\r
408 \r
409 // Decode a SMD file\r
410 static int DecodeSmd(unsigned char *data,int len)\r
411 {\r
412   unsigned char *temp=NULL;\r
413   int i=0;\r
414 \r
415   temp=(unsigned char *)malloc(0x4000);\r
416   if (temp==NULL) return 1;\r
417   memset(temp,0,0x4000);\r
418 \r
419   // Interleve each 16k block and shift down by 0x200:\r
420   for (i=0; i+0x4200<=len; i+=0x4000)\r
421   {\r
422     InterleveBlock(temp,data+0x200+i); // Interleve 16k to temporary buffer\r
423     memcpy(data+i,temp,0x4000); // Copy back in\r
424   }\r
425 \r
426   free(temp);\r
427   return 0;\r
428 }\r
429 \r
430 static unsigned char *PicoCartAlloc(int filesize, int is_sms)\r
431 {\r
432   unsigned char *rom;\r
433 \r
434   if (is_sms) {\r
435     // make size power of 2 for easier banking handling\r
436     int s = 0, tmp = filesize;\r
437     while ((tmp >>= 1) != 0)\r
438       s++;\r
439     if (filesize > (1 << s))\r
440       s++;\r
441     rom_alloc_size = 1 << s;\r
442     // be sure we can cover all address space\r
443     if (rom_alloc_size < 0x10000)\r
444       rom_alloc_size = 0x10000;\r
445   }\r
446   else {\r
447     // make alloc size at least sizeof(mcd_state),\r
448     // in case we want to switch to CD mode\r
449     if (filesize < sizeof(mcd_state))\r
450       filesize = sizeof(mcd_state);\r
451 \r
452     // align to 512K for memhandlers\r
453     rom_alloc_size = (filesize + 0x7ffff) & ~0x7ffff;\r
454   }\r
455 \r
456   if (rom_alloc_size - filesize < 4)\r
457     rom_alloc_size += 4; // padding for out-of-bound exec protection\r
458 \r
459   // Allocate space for the rom plus padding\r
460   // use special address for 32x dynarec\r
461   rom = plat_mmap(0x02000000, rom_alloc_size, 0, 0);\r
462   return rom;\r
463 }\r
464 \r
465 int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms)\r
466 {\r
467   unsigned char *rom;\r
468   int size, bytes_read;\r
469 \r
470   if (f == NULL)\r
471     return 1;\r
472 \r
473   size = f->size;\r
474   if (size <= 0) return 1;\r
475   size = (size+3)&~3; // Round up to a multiple of 4\r
476 \r
477   // Allocate space for the rom plus padding\r
478   rom = PicoCartAlloc(size, is_sms);\r
479   if (rom == NULL) {\r
480     elprintf(EL_STATUS, "out of memory (wanted %i)", size);\r
481     return 2;\r
482   }\r
483 \r
484   if (PicoCartLoadProgressCB != NULL)\r
485   {\r
486     // read ROM in blocks, just for fun\r
487     int ret;\r
488     unsigned char *p = rom;\r
489     bytes_read=0;\r
490     do\r
491     {\r
492       int todo = size - bytes_read;\r
493       if (todo > 256*1024) todo = 256*1024;\r
494       ret = pm_read(p,todo,f);\r
495       bytes_read += ret;\r
496       p += ret;\r
497       PicoCartLoadProgressCB(bytes_read * 100 / size);\r
498     }\r
499     while (ret > 0);\r
500   }\r
501   else\r
502     bytes_read = pm_read(rom,size,f); // Load up the rom\r
503   if (bytes_read <= 0) {\r
504     elprintf(EL_STATUS, "read failed");\r
505     free(rom);\r
506     return 3;\r
507   }\r
508 \r
509   if (!is_sms)\r
510   {\r
511     // maybe we are loading MegaCD BIOS?\r
512     if (!(PicoAHW & PAHW_MCD) && size == 0x20000 && (!strncmp((char *)rom+0x124, "BOOT", 4) ||\r
513          !strncmp((char *)rom+0x128, "BOOT", 4))) {\r
514       PicoAHW |= PAHW_MCD;\r
515     }\r
516 \r
517     // Check for SMD:\r
518     if (size >= 0x4200 && (size&0x3fff) == 0x200 &&\r
519         ((rom[0x2280] == 'S' && rom[0x280] == 'E') || (rom[0x280] == 'S' && rom[0x2281] == 'E'))) {\r
520       elprintf(EL_STATUS, "SMD format detected.");\r
521       DecodeSmd(rom,size); size-=0x200; // Decode and byteswap SMD\r
522     }\r
523     else Byteswap(rom, rom, size); // Just byteswap\r
524   }\r
525   else\r
526   {\r
527     if (size >= 0x4200 && (size&0x3fff) == 0x200) {\r
528       elprintf(EL_STATUS, "SMD format detected.");\r
529       // at least here it's not interleaved\r
530       size -= 0x200;\r
531       memmove(rom, rom + 0x200, size);\r
532     }\r
533   }\r
534 \r
535   if (prom)  *prom = rom;\r
536   if (psize) *psize = size;\r
537 \r
538   return 0;\r
539 }\r
540 \r
541 // Insert a cartridge:\r
542 int PicoCartInsert(unsigned char *rom, unsigned int romsize, const char *carthw_cfg)\r
543 {\r
544   // notaz: add a 68k "jump one op back" opcode to the end of ROM.\r
545   // This will hang the emu, but will prevent nasty crashes.\r
546   // note: 4 bytes are padded to every ROM\r
547   if (rom != NULL)\r
548     *(unsigned long *)(rom+romsize) = 0xFFFE4EFA; // 4EFA FFFE byteswapped\r
549 \r
550   Pico.rom=rom;\r
551   Pico.romsize=romsize;\r
552 \r
553   if (SRam.data) {\r
554     free(SRam.data);\r
555     SRam.data = NULL;\r
556   }\r
557 \r
558   if (PicoCartUnloadHook != NULL) {\r
559     PicoCartUnloadHook();\r
560     PicoCartUnloadHook = NULL;\r
561   }\r
562   pdb_cleanup();\r
563 \r
564   PicoAHW &= PAHW_MCD|PAHW_SMS;\r
565 \r
566   PicoCartMemSetup = NULL;\r
567   PicoDmaHook = NULL;\r
568   PicoResetHook = NULL;\r
569   PicoLineHook = NULL;\r
570   PicoLoadStateHook = NULL;\r
571   carthw_chunks = NULL;\r
572 \r
573   if (!(PicoAHW & (PAHW_MCD|PAHW_SMS)))\r
574     PicoCartDetect(carthw_cfg);\r
575 \r
576   // setup correct memory map for loaded ROM\r
577   switch (PicoAHW) {\r
578     default:\r
579       elprintf(EL_STATUS|EL_ANOMALY, "starting in unknown hw configuration: %x", PicoAHW);\r
580     case 0:\r
581     case PAHW_SVP:  PicoMemSetup(); break;\r
582     case PAHW_MCD:  PicoMemSetupCD(); break;\r
583     case PAHW_PICO: PicoMemSetupPico(); break;\r
584     case PAHW_SMS:  PicoMemSetupMS(); break;\r
585   }\r
586 \r
587   if (PicoCartMemSetup != NULL)\r
588     PicoCartMemSetup();\r
589 \r
590   if (PicoAHW & PAHW_SMS)\r
591     PicoPowerMS();\r
592   else\r
593     PicoPower();\r
594 \r
595   return 0;\r
596 }\r
597 \r
598 int PicoCartResize(int newsize)\r
599 {\r
600   void *tmp = plat_mremap(Pico.rom, rom_alloc_size, newsize);\r
601   if (tmp == NULL)\r
602     return -1;\r
603 \r
604   Pico.rom = tmp;\r
605   rom_alloc_size = newsize;\r
606   return 0;\r
607 }\r
608 \r
609 void PicoCartUnload(void)\r
610 {\r
611   if (PicoCartUnloadHook != NULL) {\r
612     PicoCartUnloadHook();\r
613     PicoCartUnloadHook = NULL;\r
614   }\r
615 \r
616   if (PicoAHW & PAHW_32X)\r
617     PicoUnload32x();\r
618 \r
619   if (Pico.rom != NULL) {\r
620     SekFinishIdleDet();\r
621     plat_munmap(Pico.rom, rom_alloc_size);\r
622     Pico.rom = NULL;\r
623   }\r
624 }\r
625 \r
626 static unsigned int rom_crc32(void)\r
627 {\r
628   unsigned int crc;\r
629   elprintf(EL_STATUS, "caclulating CRC32..");\r
630 \r
631   // have to unbyteswap for calculation..\r
632   Byteswap(Pico.rom, Pico.rom, Pico.romsize);\r
633   crc = crc32(0, Pico.rom, Pico.romsize);\r
634   Byteswap(Pico.rom, Pico.rom, Pico.romsize);\r
635   return crc;\r
636 }\r
637 \r
638 static int rom_strcmp(int rom_offset, const char *s1)\r
639 {\r
640   int i, len = strlen(s1);\r
641   const char *s_rom = (const char *)Pico.rom;\r
642   for (i = 0; i < len; i++)\r
643     if (s1[i] != s_rom[(i + rom_offset) ^ 1])\r
644       return 1;\r
645   return 0;\r
646 }\r
647 \r
648 static unsigned int rom_read32(int addr)\r
649 {\r
650   unsigned short *m = (unsigned short *)(Pico.rom + addr);\r
651   return (m[0] << 16) | m[1];\r
652 }\r
653 \r
654 static char *sskip(char *s)\r
655 {\r
656   while (*s && isspace_(*s))\r
657     s++;\r
658   return s;\r
659 }\r
660 \r
661 static void rstrip(char *s)\r
662 {\r
663   char *p;\r
664   for (p = s + strlen(s) - 1; p >= s; p--)\r
665     if (isspace_(*p))\r
666       *p = 0;\r
667 }\r
668 \r
669 static int parse_3_vals(char *p, int *val0, int *val1, int *val2)\r
670 {\r
671   char *r;\r
672   *val0 = strtoul(p, &r, 0);\r
673   if (r == p)\r
674     goto bad;\r
675   p = sskip(r);\r
676   if (*p++ != ',')\r
677     goto bad;\r
678   *val1 = strtoul(p, &r, 0);\r
679   if (r == p)\r
680     goto bad;\r
681   p = sskip(r);\r
682   if (*p++ != ',')\r
683     goto bad;\r
684   *val2 = strtoul(p, &r, 0);\r
685   if (r == p)\r
686     goto bad;\r
687 \r
688   return 1;\r
689 bad:\r
690   return 0;\r
691 }\r
692 \r
693 static int is_expr(const char *expr, char **pr)\r
694 {\r
695   int len = strlen(expr);\r
696   char *p = *pr;\r
697 \r
698   if (strncmp(expr, p, len) != 0)\r
699     return 0;\r
700   p = sskip(p + len);\r
701   if (*p != '=')\r
702     return 0; // wrong or malformed\r
703 \r
704   *pr = sskip(p + 1);\r
705   return 1;\r
706 }\r
707 \r
708 static void parse_carthw(const char *carthw_cfg, int *fill_sram)\r
709 {\r
710   int line = 0, any_checks_passed = 0, skip_sect = 0;\r
711   int tmp, rom_crc = 0;\r
712   char buff[256], *p, *r;\r
713   FILE *f;\r
714 \r
715   f = fopen(carthw_cfg, "r");\r
716   if (f == NULL) {\r
717     elprintf(EL_STATUS, "couldn't open carthw.cfg!");\r
718     return;\r
719   }\r
720 \r
721   while ((p = fgets(buff, sizeof(buff), f)))\r
722   {\r
723     line++;\r
724     p = sskip(p);\r
725     if (*p == 0 || *p == '#')\r
726       continue;\r
727 \r
728     if (*p == '[') {\r
729       any_checks_passed = 0;\r
730       skip_sect = 0;\r
731       continue;\r
732     }\r
733     \r
734     if (skip_sect)\r
735       continue;\r
736 \r
737     /* look for checks */\r
738     if (is_expr("check_str", &p))\r
739     {\r
740       int offs;\r
741       offs = strtoul(p, &r, 0);\r
742       if (offs < 0 || offs > Pico.romsize) {\r
743         elprintf(EL_STATUS, "carthw:%d: check_str offs out of range: %d\n", line, offs);\r
744         goto bad;\r
745       }\r
746       p = sskip(r);\r
747       if (*p != ',')\r
748         goto bad;\r
749       p = sskip(p + 1);\r
750       if (*p != '"')\r
751         goto bad;\r
752       p++;\r
753       r = strchr(p, '"');\r
754       if (r == NULL)\r
755         goto bad;\r
756       *r = 0;\r
757 \r
758       if (rom_strcmp(offs, p) == 0)\r
759         any_checks_passed = 1;\r
760       else\r
761         skip_sect = 1;\r
762       continue;\r
763     }\r
764     else if (is_expr("check_size_gt", &p))\r
765     {\r
766       int size;\r
767       size = strtoul(p, &r, 0);\r
768       if (r == p || size < 0)\r
769         goto bad;\r
770 \r
771       if (Pico.romsize > size)\r
772         any_checks_passed = 1;\r
773       else\r
774         skip_sect = 1;\r
775       continue;\r
776     }\r
777     else if (is_expr("check_csum", &p))\r
778     {\r
779       int csum;\r
780       csum = strtoul(p, &r, 0);\r
781       if (r == p || (csum & 0xffff0000))\r
782         goto bad;\r
783 \r
784       if (csum == (rom_read32(0x18c) & 0xffff))\r
785         any_checks_passed = 1;\r
786       else\r
787         skip_sect = 1;\r
788       continue;\r
789     }\r
790     else if (is_expr("check_crc32", &p))\r
791     {\r
792       unsigned int crc;\r
793       crc = strtoul(p, &r, 0);\r
794       if (r == p)\r
795         goto bad;\r
796 \r
797       if (rom_crc == 0)\r
798         rom_crc = rom_crc32();\r
799       if (crc == rom_crc)\r
800         any_checks_passed = 1;\r
801       else\r
802         skip_sect = 1;\r
803       continue;\r
804     }\r
805 \r
806     /* now time for actions */\r
807     if (is_expr("hw", &p)) {\r
808       if (!any_checks_passed)\r
809         goto no_checks;\r
810       rstrip(p);\r
811 \r
812       if      (strcmp(p, "svp") == 0)\r
813         PicoSVPStartup();\r
814       else if (strcmp(p, "pico") == 0)\r
815         PicoInitPico();\r
816       else if (strcmp(p, "prot") == 0)\r
817         carthw_sprot_startup();\r
818       else if (strcmp(p, "ssf2_mapper") == 0)\r
819         carthw_ssf2_startup();\r
820       else if (strcmp(p, "x_in_1_mapper") == 0)\r
821         carthw_Xin1_startup();\r
822       else if (strcmp(p, "realtec_mapper") == 0)\r
823         carthw_realtec_startup();\r
824       else if (strcmp(p, "radica_mapper") == 0)\r
825         carthw_radica_startup();\r
826       else if (strcmp(p, "piersolar_mapper") == 0)\r
827         carthw_pier_startup();\r
828       else if (strcmp(p, "prot_lk3") == 0)\r
829         carthw_prot_lk3_startup();\r
830       else {\r
831         elprintf(EL_STATUS, "carthw:%d: unsupported mapper: %s", line, p);\r
832         skip_sect = 1;\r
833       }\r
834       continue;\r
835     }\r
836     if (is_expr("sram_range", &p)) {\r
837       int start, end;\r
838 \r
839       if (!any_checks_passed)\r
840         goto no_checks;\r
841       rstrip(p);\r
842 \r
843       start = strtoul(p, &r, 0);\r
844       if (r == p)\r
845         goto bad;\r
846       p = sskip(r);\r
847       if (*p != ',')\r
848         goto bad;\r
849       p = sskip(p + 1);\r
850       end = strtoul(p, &r, 0);\r
851       if (r == p)\r
852         goto bad;\r
853       if (((start | end) & 0xff000000) || start > end) {\r
854         elprintf(EL_STATUS, "carthw:%d: bad sram_range: %08x - %08x", line, start, end);\r
855         goto bad_nomsg;\r
856       }\r
857       SRam.start = start;\r
858       SRam.end = end;\r
859       continue;\r
860     }\r
861     else if (is_expr("prop", &p)) {\r
862       if (!any_checks_passed)\r
863         goto no_checks;\r
864       rstrip(p);\r
865 \r
866       if      (strcmp(p, "no_sram") == 0)\r
867         SRam.flags &= ~SRF_ENABLED;\r
868       else if (strcmp(p, "no_eeprom") == 0)\r
869         SRam.flags &= ~SRF_EEPROM;\r
870       else if (strcmp(p, "filled_sram") == 0)\r
871         *fill_sram = 1;\r
872       else {\r
873         elprintf(EL_STATUS, "carthw:%d: unsupported prop: %s", line, p);\r
874         goto bad_nomsg;\r
875       }\r
876       continue;\r
877     }\r
878     else if (is_expr("eeprom_type", &p)) {\r
879       int type;\r
880       if (!any_checks_passed)\r
881         goto no_checks;\r
882       rstrip(p);\r
883 \r
884       type = strtoul(p, &r, 0);\r
885       if (r == p || type < 0)\r
886         goto bad;\r
887       SRam.eeprom_type = type;\r
888       SRam.flags |= SRF_EEPROM;\r
889       continue;\r
890     }\r
891     else if (is_expr("eeprom_lines", &p)) {\r
892       int scl, sda_in, sda_out;\r
893       if (!any_checks_passed)\r
894         goto no_checks;\r
895       rstrip(p);\r
896 \r
897       if (!parse_3_vals(p, &scl, &sda_in, &sda_out))\r
898         goto bad;\r
899       if (scl < 0 || scl > 15 || sda_in < 0 || sda_in > 15 ||\r
900           sda_out < 0 || sda_out > 15)\r
901         goto bad;\r
902 \r
903       SRam.eeprom_bit_cl = scl;\r
904       SRam.eeprom_bit_in = sda_in;\r
905       SRam.eeprom_bit_out= sda_out;\r
906       continue;\r
907     }\r
908     else if ((tmp = is_expr("prot_ro_value16", &p)) || is_expr("prot_rw_value16", &p)) {\r
909       int addr, mask, val;\r
910       if (!any_checks_passed)\r
911         goto no_checks;\r
912       rstrip(p);\r
913 \r
914       if (!parse_3_vals(p, &addr, &mask, &val))\r
915         goto bad;\r
916 \r
917       carthw_sprot_new_location(addr, mask, val, tmp ? 1 : 0);\r
918       continue;\r
919     }\r
920 \r
921 \r
922 bad:\r
923     elprintf(EL_STATUS, "carthw:%d: unrecognized expression: %s", line, buff);\r
924 bad_nomsg:\r
925     skip_sect = 1;\r
926     continue;\r
927 \r
928 no_checks:\r
929     elprintf(EL_STATUS, "carthw:%d: command without any checks before it: %s", line, buff);\r
930     skip_sect = 1;\r
931     continue;\r
932   }\r
933   fclose(f);\r
934 }\r
935 \r
936 /*\r
937  * various cart-specific things, which can't be handled by generic code\r
938  */\r
939 static void PicoCartDetect(const char *carthw_cfg)\r
940 {\r
941   int fill_sram = 0;\r
942 \r
943   memset(&SRam, 0, sizeof(SRam));\r
944   if (Pico.rom[0x1B1] == 'R' && Pico.rom[0x1B0] == 'A')\r
945   {\r
946     SRam.start =  rom_read32(0x1B4) & ~0xff000001; // align\r
947     SRam.end   = (rom_read32(0x1B8) & ~0xff000000) | 1;\r
948     if (Pico.rom[0x1B2] & 0x40)\r
949       // EEPROM\r
950       SRam.flags |= SRF_EEPROM;\r
951     SRam.flags |= SRF_ENABLED;\r
952   }\r
953   if (SRam.end == 0 || SRam.start > SRam.end)\r
954   {\r
955     // some games may have bad headers, like S&K and Sonic3\r
956     // note: majority games use 0x200000 as starting address, but there are some which\r
957     // use something else (0x300000 by HardBall '95). Luckily they have good headers.\r
958     SRam.start = 0x200000;\r
959     SRam.end   = 0x203FFF;\r
960     SRam.flags |= SRF_ENABLED;\r
961   }\r
962 \r
963   // set EEPROM defaults, in case it gets detected\r
964   SRam.eeprom_type   = 0; // 7bit (24C01)\r
965   SRam.eeprom_bit_cl = 1;\r
966   SRam.eeprom_bit_in = 0;\r
967   SRam.eeprom_bit_out= 0;\r
968 \r
969   if (carthw_cfg != NULL)\r
970     parse_carthw(carthw_cfg, &fill_sram);\r
971 \r
972   if (SRam.flags & SRF_ENABLED)\r
973   {\r
974     if (SRam.flags & SRF_EEPROM)\r
975       SRam.size = 0x2000;\r
976     else\r
977       SRam.size = SRam.end - SRam.start + 1;\r
978 \r
979     SRam.data = calloc(SRam.size, 1);\r
980     if (SRam.data == NULL)\r
981       SRam.flags &= ~SRF_ENABLED;\r
982 \r
983     if (SRam.eeprom_type == 1)  // 1 == 0 in PD EEPROM code\r
984       SRam.eeprom_type = 0;\r
985   }\r
986 \r
987   if ((SRam.flags & SRF_ENABLED) && fill_sram)\r
988   {\r
989     elprintf(EL_STATUS, "SRAM fill");\r
990     memset(SRam.data, 0xff, SRam.size);\r
991   }\r
992 \r
993   // Unusual region 'code'\r
994   if (rom_strcmp(0x1f0, "EUROPE") == 0 || rom_strcmp(0x1f0, "Europe") == 0)\r
995     *(int *) (Pico.rom + 0x1f0) = 0x20204520;\r
996 }\r
997 \r