1 // This is part of Pico Library
\r
3 // (c) Copyright 2004 Dave, All rights reserved.
\r
4 // (c) Copyright 2006-2007, Grazvydas "notaz" Ignotas
\r
5 // Free for non-commercial use.
\r
7 // For commercial use, separate licencing terms must be obtained.
\r
10 #include "pico_int.h"
\r
11 #include "../zlib/zlib.h"
\r
12 #include "../unzip/unzip.h"
\r
13 #include "../unzip/unzip_stream.h"
\r
16 static const char *rom_exts[] = { "bin", "gen", "smd", "iso", "sms", "gg", "sg" };
\r
18 void (*PicoCartUnloadHook)(void) = NULL;
\r
20 void (*PicoCartLoadProgressCB)(int percent) = NULL;
\r
21 void (*PicoCDLoadProgressCB)(const char *fname, int percent) = NULL; // handled in Pico/cd/cd_file.c
\r
23 static void PicoCartDetect(void);
\r
26 typedef struct _cso_struct
\r
28 unsigned char in_buff[2*2048];
\r
29 unsigned char out_buff[2048];
\r
32 unsigned int unused;
\r
33 unsigned int total_bytes;
\r
34 unsigned int total_bytes_high; // ignored here
\r
35 unsigned int block_size; // 10h
\r
37 unsigned char align;
\r
38 unsigned char reserved[2];
\r
40 unsigned int fpos_in; // input file read pointer
\r
41 unsigned int fpos_out; // pos in virtual decompressed file
\r
42 int block_in_buff; // block which we have read in in_buff
\r
48 static int uncompress2(void *dest, int destLen, void *source, int sourceLen)
\r
53 stream.next_in = (Bytef*)source;
\r
54 stream.avail_in = (uInt)sourceLen;
\r
55 stream.next_out = dest;
\r
56 stream.avail_out = (uInt)destLen;
\r
58 stream.zalloc = NULL;
\r
59 stream.zfree = NULL;
\r
61 err = inflateInit2(&stream, -15);
\r
62 if (err != Z_OK) return err;
\r
64 err = inflate(&stream, Z_FINISH);
\r
65 if (err != Z_STREAM_END) {
\r
66 inflateEnd(&stream);
\r
69 //*destLen = stream.total_out;
\r
71 return inflateEnd(&stream);
\r
74 static const char *get_ext(const char *path)
\r
77 if (strlen(path) < 4)
\r
78 return ""; // no ext
\r
80 // allow 2 or 3 char extensions for now
\r
81 ext = path + strlen(path) - 2;
\r
82 if (ext[-1] != '.') ext--;
\r
88 pm_file *pm_open(const char *path)
\r
90 pm_file *file = NULL;
\r
97 ext = get_ext(path);
\r
98 if (strcasecmp(ext, "zip") == 0)
\r
100 struct zipent *zipentry;
\r
105 zipfile = openzip(path);
\r
106 if (zipfile != NULL)
\r
108 /* search for suitable file (right extension or large enough file) */
\r
109 while ((zipentry = readzip(zipfile)) != NULL)
\r
111 ext = get_ext(zipentry->name);
\r
113 if (zipentry->uncompressed_size >= 32*1024)
\r
114 goto found_rom_zip;
\r
116 for (i = 0; i < sizeof(rom_exts)/sizeof(rom_exts[0]); i++)
\r
117 if (strcasecmp(ext, rom_exts[i]) == 0)
\r
118 goto found_rom_zip;
\r
121 /* zipfile given, but nothing found suitable for us inside */
\r
125 /* try to convert to gzip stream, so we could use standard gzio functions from zlib */
\r
126 gzf = zip2gz(zipfile, zipentry);
\r
127 if (gzf == NULL) goto zip_failed;
\r
129 file = calloc(1, sizeof(*file));
\r
130 if (file == NULL) goto zip_failed;
\r
131 file->file = zipfile;
\r
133 file->size = zipentry->uncompressed_size;
\r
134 file->type = PMT_ZIP;
\r
135 strncpy(file->ext, ext, sizeof(file->ext) - 1);
\r
141 zipfile->fp = NULL; // gzclose() closed it
\r
147 else if (strcasecmp(ext, "cso") == 0)
\r
149 cso_struct *cso = NULL, *tmp = NULL;
\r
151 f = fopen(path, "rb");
\r
156 /* we use our own buffering */
\r
157 setvbuf(f, NULL, _IONBF, 0);
\r
160 cso = malloc(sizeof(*cso));
\r
164 if (fread(&cso->header, 1, sizeof(cso->header), f) != sizeof(cso->header))
\r
167 if (strncmp(cso->header.magic, "CISO", 4) != 0) {
\r
168 elprintf(EL_STATUS, "cso: bad header");
\r
172 if (cso->header.block_size != 2048) {
\r
173 elprintf(EL_STATUS, "cso: bad block size (%u)", cso->header.block_size);
\r
177 size = ((cso->header.total_bytes >> 11) + 1)*4 + sizeof(*cso);
\r
178 tmp = realloc(cso, size);
\r
182 elprintf(EL_STATUS, "allocated %i bytes for CSO struct", size);
\r
184 size -= sizeof(*cso); // index size
\r
185 if (fread(cso->index, 1, size, f) != size) {
\r
186 elprintf(EL_STATUS, "cso: premature EOF");
\r
191 cso->fpos_in = ftell(f);
\r
193 cso->block_in_buff = -1;
\r
194 file = calloc(1, sizeof(*file));
\r
195 if (file == NULL) goto cso_failed;
\r
198 file->size = cso->header.total_bytes;
\r
199 file->type = PMT_CSO;
\r
203 if (cso != NULL) free(cso);
\r
204 if (f != NULL) fclose(f);
\r
208 /* not a zip, treat as uncompressed file */
\r
209 f = fopen(path, "rb");
\r
210 if (f == NULL) return NULL;
\r
212 file = calloc(1, sizeof(*file));
\r
213 if (file == NULL) {
\r
217 fseek(f, 0, SEEK_END);
\r
219 file->param = NULL;
\r
220 file->size = ftell(f);
\r
221 file->type = PMT_UNCOMPRESSED;
\r
222 strncpy(file->ext, ext, sizeof(file->ext) - 1);
\r
223 fseek(f, 0, SEEK_SET);
\r
225 #ifndef __EPOC32__ // makes things worse on Symbian
\r
226 if (file->size > 0x400000)
\r
227 /* we use our own buffering */
\r
228 setvbuf(f, NULL, _IONBF, 0);
\r
234 size_t pm_read(void *ptr, size_t bytes, pm_file *stream)
\r
238 if (stream->type == PMT_UNCOMPRESSED)
\r
240 ret = fread(ptr, 1, bytes, stream->file);
\r
242 else if (stream->type == PMT_ZIP)
\r
244 gzFile gf = stream->param;
\r
246 ret = gzread(gf, ptr, bytes);
\r
247 err = gzerror2(gf);
\r
248 if (ret > 0 && (err == Z_DATA_ERROR || err == Z_STREAM_END))
\r
249 /* we must reset stream pointer or else next seek/read fails */
\r
252 else if (stream->type == PMT_CSO)
\r
254 cso_struct *cso = stream->param;
\r
255 int read_pos, read_len, out_offs, rret;
\r
256 int block = cso->fpos_out >> 11;
\r
257 int index = cso->index[block];
\r
258 int index_end = cso->index[block+1];
\r
259 unsigned char *out = ptr, *tmp_dst;
\r
264 out_offs = cso->fpos_out&0x7ff;
\r
265 if (out_offs == 0 && bytes >= 2048)
\r
267 else tmp_dst = cso->out_buff;
\r
269 read_pos = (index&0x7fffffff) << cso->header.align;
\r
272 if (read_pos != cso->fpos_in)
\r
273 fseek(stream->file, read_pos, SEEK_SET);
\r
274 rret = fread(tmp_dst, 1, 2048, stream->file);
\r
275 cso->fpos_in = read_pos + rret;
\r
276 if (rret != 2048) break;
\r
278 read_len = (((index_end&0x7fffffff) << cso->header.align) - read_pos) & 0xfff;
\r
279 if (block != cso->block_in_buff)
\r
281 if (read_pos != cso->fpos_in)
\r
282 fseek(stream->file, read_pos, SEEK_SET);
\r
283 rret = fread(cso->in_buff, 1, read_len, stream->file);
\r
284 cso->fpos_in = read_pos + rret;
\r
285 if (rret != read_len) {
\r
286 elprintf(EL_STATUS, "cso: read failed @ %08x", read_pos);
\r
289 cso->block_in_buff = block;
\r
291 rret = uncompress2(tmp_dst, 2048, cso->in_buff, read_len);
\r
293 elprintf(EL_STATUS, "cso: uncompress failed @ %08x with %i", read_pos, rret);
\r
299 if (out_offs != 0 || bytes < 2048) {
\r
300 //elprintf(EL_STATUS, "cso: unaligned/nonfull @ %08x, offs=%i, len=%u", cso->fpos_out, out_offs, bytes);
\r
301 if (bytes < rret) rret = bytes;
\r
302 if (2048 - out_offs < rret) rret = 2048 - out_offs;
\r
303 memcpy(out, tmp_dst + out_offs, rret);
\r
307 cso->fpos_out += rret;
\r
311 index_end = cso->index[block+1];
\r
320 int pm_seek(pm_file *stream, long offset, int whence)
\r
322 if (stream->type == PMT_UNCOMPRESSED)
\r
324 fseek(stream->file, offset, whence);
\r
325 return ftell(stream->file);
\r
327 else if (stream->type == PMT_ZIP)
\r
329 if (PicoMessage != NULL && offset > 6*1024*1024) {
\r
330 long pos = gztell((gzFile) stream->param);
\r
331 if (offset < pos || offset - pos > 6*1024*1024)
\r
332 PicoMessage("Decompressing data...");
\r
334 return gzseek((gzFile) stream->param, offset, whence);
\r
336 else if (stream->type == PMT_CSO)
\r
338 cso_struct *cso = stream->param;
\r
341 case SEEK_CUR: cso->fpos_out += offset; break;
\r
342 case SEEK_SET: cso->fpos_out = offset; break;
\r
343 case SEEK_END: cso->fpos_out = cso->header.total_bytes - offset; break;
\r
345 return cso->fpos_out;
\r
351 int pm_close(pm_file *fp)
\r
355 if (fp == NULL) return EOF;
\r
357 if (fp->type == PMT_UNCOMPRESSED)
\r
361 else if (fp->type == PMT_ZIP)
\r
363 ZIP *zipfile = fp->file;
\r
364 gzclose((gzFile) fp->param);
\r
365 zipfile->fp = NULL; // gzclose() closed it
\r
368 else if (fp->type == PMT_CSO)
\r
381 void Byteswap(unsigned char *data,int len)
\r
385 if (len<2) return; // Too short
\r
389 unsigned short *pd=(unsigned short *)(data+i);
\r
390 int value=*pd; // Get 2 bytes
\r
392 value=(value<<8)|(value>>8); // Byteswap it
\r
393 *pd=(unsigned short)value; // Put 2b ytes
\r
399 // Interleve a 16k block and byteswap
\r
400 static int InterleveBlock(unsigned char *dest,unsigned char *src)
\r
403 for (i=0;i<0x2000;i++) dest[(i<<1) ]=src[ i]; // Odd
\r
404 for (i=0;i<0x2000;i++) dest[(i<<1)+1]=src[0x2000+i]; // Even
\r
408 // Decode a SMD file
\r
409 static int DecodeSmd(unsigned char *data,int len)
\r
411 unsigned char *temp=NULL;
\r
414 temp=(unsigned char *)malloc(0x4000);
\r
415 if (temp==NULL) return 1;
\r
416 memset(temp,0,0x4000);
\r
418 // Interleve each 16k block and shift down by 0x200:
\r
419 for (i=0; i+0x4200<=len; i+=0x4000)
\r
421 InterleveBlock(temp,data+0x200+i); // Interleve 16k to temporary buffer
\r
422 memcpy(data+i,temp,0x4000); // Copy back in
\r
429 static unsigned char *cd_realloc(void *old, int filesize)
\r
431 unsigned char *rom;
\r
432 rom=realloc(old, sizeof(mcd_state));
\r
433 if (rom) memset(rom+0x20000, 0, sizeof(mcd_state)-0x20000);
\r
437 static unsigned char *PicoCartAlloc(int filesize, int is_sms)
\r
440 unsigned char *rom;
\r
442 if (PicoAHW & PAHW_MCD)
\r
443 return cd_realloc(NULL, filesize);
\r
446 // make size power of 2 for easier banking handling
\r
447 int s = 0, tmp = filesize;
\r
448 while ((tmp >>= 1) != 0)
\r
450 if (filesize > (1 << s))
\r
452 alloc_size = 1 << s;
\r
455 // align to 512K for memhandlers
\r
456 alloc_size = (filesize + 0x7ffff) & ~0x7ffff;
\r
459 if (alloc_size - filesize < 4)
\r
460 alloc_size += 4; // padding for out-of-bound exec protection
\r
462 // Allocate space for the rom plus padding
\r
463 rom = calloc(alloc_size, 1);
\r
467 int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize,int is_sms)
\r
469 unsigned char *rom;
\r
470 int size, bytes_read;
\r
476 if (size <= 0) return 1;
\r
477 size = (size+3)&~3; // Round up to a multiple of 4
\r
479 // Allocate space for the rom plus padding
\r
480 rom = PicoCartAlloc(size, is_sms);
\r
482 elprintf(EL_STATUS, "out of memory (wanted %i)", size);
\r
486 if (PicoCartLoadProgressCB != NULL)
\r
488 // read ROM in blocks, just for fun
\r
490 unsigned char *p = rom;
\r
494 int todo = size - bytes_read;
\r
495 if (todo > 256*1024) todo = 256*1024;
\r
496 ret = pm_read(p,todo,f);
\r
499 PicoCartLoadProgressCB(bytes_read * 100 / size);
\r
504 bytes_read = pm_read(rom,size,f); // Load up the rom
\r
505 if (bytes_read <= 0) {
\r
506 elprintf(EL_STATUS, "read failed");
\r
513 // maybe we are loading MegaCD BIOS?
\r
514 if (!(PicoAHW & PAHW_MCD) && size == 0x20000 && (!strncmp((char *)rom+0x124, "BOOT", 4) ||
\r
515 !strncmp((char *)rom+0x128, "BOOT", 4))) {
\r
516 PicoAHW |= PAHW_MCD;
\r
517 rom = cd_realloc(rom, size);
\r
521 if (size >= 0x4200 && (size&0x3fff) == 0x200 &&
\r
522 ((rom[0x2280] == 'S' && rom[0x280] == 'E') || (rom[0x280] == 'S' && rom[0x2281] == 'E'))) {
\r
523 elprintf(EL_STATUS, "SMD format detected.");
\r
524 DecodeSmd(rom,size); size-=0x200; // Decode and byteswap SMD
\r
526 else Byteswap(rom,size); // Just byteswap
\r
530 if (size >= 0x4200 && (size&0x3fff) == 0x200) {
\r
531 elprintf(EL_STATUS, "SMD format detected.");
\r
532 // at least here it's not interleaved
\r
534 memmove(rom, rom + 0x200, size);
\r
538 if (prom) *prom = rom;
\r
539 if (psize) *psize = size;
\r
544 // Insert a cartridge:
\r
545 int PicoCartInsert(unsigned char *rom,unsigned int romsize)
\r
547 // notaz: add a 68k "jump one op back" opcode to the end of ROM.
\r
548 // This will hang the emu, but will prevent nasty crashes.
\r
549 // note: 4 bytes are padded to every ROM
\r
551 *(unsigned long *)(rom+romsize) = 0xFFFE4EFA; // 4EFA FFFE byteswapped
\r
554 Pico.romsize=romsize;
\r
561 if (PicoCartUnloadHook != NULL) {
\r
562 PicoCartUnloadHook();
\r
563 PicoCartUnloadHook = NULL;
\r
566 PicoAHW &= PAHW_MCD|PAHW_SMS;
\r
568 PicoMemResetHooks();
\r
569 PicoDmaHook = NULL;
\r
570 PicoResetHook = NULL;
\r
571 PicoLineHook = NULL;
\r
572 PicoLoadStateHook = NULL;
\r
573 carthw_chunks = NULL;
\r
577 if (!(PicoAHW & (PAHW_MCD|PAHW_SMS)))
\r
580 // setup correct memory map for loaded ROM
\r
581 // call PicoMemReset again due to possible memmap change
\r
584 elprintf(EL_STATUS|EL_ANOMALY, "starting in unknown hw configuration: %x", PicoAHW);
\r
586 case PAHW_SVP: PicoMemSetup(); break;
\r
587 case PAHW_MCD: PicoMemSetupCD(); break;
\r
588 case PAHW_PICO: PicoMemSetupPico(); break;
\r
589 case PAHW_SMS: PicoMemSetupMS(); break;
\r
593 if (PicoAHW & PAHW_SMS)
\r
601 void PicoCartUnload(void)
\r
603 if (PicoCartUnloadHook != NULL) {
\r
604 PicoCartUnloadHook();
\r
605 PicoCartUnloadHook = NULL;
\r
608 if (Pico.rom != NULL) {
\r
609 SekFinishIdleDet();
\r
615 static int rom_strcmp(int rom_offset, const char *s1)
\r
617 int i, len = strlen(s1);
\r
618 const char *s_rom = (const char *)Pico.rom + rom_offset;
\r
619 for (i = 0; i < len; i++)
\r
620 if (s1[i] != s_rom[i^1])
\r
625 static int name_cmp(const char *name)
\r
627 return rom_strcmp(0x150, name);
\r
631 * various cart-specific things, which can't be handled by generic code
\r
632 * (maybe I should start using CRC for this stuff?)
\r
634 static void PicoCartDetect(void)
\r
636 int sram_size = 0, csum;
\r
637 Pico.m.sram_reg = 0;
\r
639 csum = PicoRead32(0x18c) & 0xffff;
\r
641 if (Pico.rom[0x1B1] == 'R' && Pico.rom[0x1B0] == 'A')
\r
643 if (Pico.rom[0x1B2] & 0x40)
\r
646 SRam.start = PicoRead32(0x1B4) & ~1; // zero address is used for clock by some games
\r
647 SRam.end = PicoRead32(0x1B8);
\r
648 sram_size = 0x2000;
\r
649 Pico.m.sram_reg |= 4;
\r
652 SRam.start = PicoRead32(0x1B4) & ~0xff;
\r
653 SRam.end = PicoRead32(0x1B8) | 1;
\r
654 sram_size = SRam.end - SRam.start + 1;
\r
656 SRam.start &= ~0xff000000;
\r
657 SRam.end &= ~0xff000000;
\r
658 Pico.m.sram_reg |= 0x10; // SRAM was detected
\r
660 if (sram_size <= 0)
\r
662 // some games may have bad headers, like S&K and Sonic3
\r
663 // note: majority games use 0x200000 as starting address, but there are some which
\r
664 // use something else (0x300000 by HardBall '95). Luckily they have good headers.
\r
665 SRam.start = 0x200000;
\r
666 SRam.end = 0x203FFF;
\r
667 sram_size = 0x004000;
\r
670 // this game actually doesn't have SRAM, but some weird protection
\r
671 if (rom_strcmp(0x120, "PUGGSY") == 0)
\r
673 SRam.start = SRam.end = sram_size = 0;
\r
678 SRam.data = (unsigned char *) calloc(sram_size, 1);
\r
679 if (SRam.data == NULL) return;
\r
683 // set EEPROM defaults, in case it gets detected
\r
684 SRam.eeprom_type = 0; // 7bit (24C01)
\r
685 SRam.eeprom_abits = 3; // eeprom access must be odd addr for: bit0 ~ cl, bit1 ~ in
\r
686 SRam.eeprom_bit_cl = 1;
\r
687 SRam.eeprom_bit_in = 0;
\r
688 SRam.eeprom_bit_out= 0;
\r
690 // some known EEPROM data (thanks to EkeEke)
\r
691 if (name_cmp("COLLEGE SLAM") == 0 ||
\r
692 name_cmp("FRANK THOMAS BIGHURT BASEBAL") == 0)
\r
694 SRam.eeprom_type = 3;
\r
695 SRam.eeprom_abits = 2;
\r
696 SRam.eeprom_bit_cl = 0;
\r
698 else if (name_cmp("NBA JAM TOURNAMENT EDITION") == 0 ||
\r
699 name_cmp("NFL QUARTERBACK CLUB") == 0)
\r
701 SRam.eeprom_type = 2;
\r
702 SRam.eeprom_abits = 2;
\r
703 SRam.eeprom_bit_cl = 0;
\r
705 else if (name_cmp("NBA JAM") == 0)
\r
707 SRam.eeprom_type = 2;
\r
708 SRam.eeprom_bit_out = 1;
\r
709 SRam.eeprom_abits = 0;
\r
711 else if (name_cmp("NHLPA HOCKEY '93") == 0 ||
\r
712 name_cmp("NHLPA Hockey '93") == 0 ||
\r
713 name_cmp("RINGS OF POWER") == 0)
\r
715 SRam.start = SRam.end = 0x200000;
\r
716 Pico.m.sram_reg = 0x14;
\r
717 SRam.eeprom_abits = 0;
\r
718 SRam.eeprom_bit_cl = 6;
\r
719 SRam.eeprom_bit_in = 7;
\r
720 SRam.eeprom_bit_out= 7;
\r
722 else if ( name_cmp("MICRO MACHINES II") == 0 ||
\r
723 (name_cmp(" ") == 0 && // Micro Machines {Turbo Tournament '96, Military - It's a Blast!}
\r
724 (csum == 0x165e || csum == 0x168b || csum == 0xCEE0 || csum == 0x2C41)))
\r
726 SRam.start = 0x300000;
\r
727 SRam.end = 0x380001;
\r
728 Pico.m.sram_reg = 0x14;
\r
729 SRam.eeprom_type = 2;
\r
730 SRam.eeprom_abits = 0;
\r
731 SRam.eeprom_bit_cl = 1;
\r
732 SRam.eeprom_bit_in = 0;
\r
733 SRam.eeprom_bit_out= 7;
\r
737 else if (name_cmp("Virtua Racing") == 0 ||
\r
738 name_cmp("VIRTUA RACING") == 0)
\r
744 else if (rom_strcmp(0x100, "SEGA PICO") == 0 ||
\r
745 rom_strcmp(0x100, "IMA IKUNOUJYUKU") == 0) // what is that supposed to mean?
\r
750 // Detect 12-in-1 mapper
\r
751 else if ((name_cmp("ROBOCOP 3") == 0 && Pico.romsize == 0x200000) ||
\r
752 (rom_strcmp(0x160, "FLICKY") == 0 && Pico.romsize >= 0x200000) ||
\r
753 (name_cmp(" SHOVE IT!") == 0 && Pico.romsize >= 0x200000) ||
\r
754 (name_cmp("MS PACMAN") == 0 && Pico.romsize >= 0x200000) || // bad dump?
\r
755 (name_cmp("ALIEN 3") == 0 && Pico.romsize == 0x200000))
\r
757 carthw_12in1_startup();
\r
761 else if (Pico.romsize == 512*1024 && (
\r
762 rom_strcmp(0x94, "THE EARTH DEFEND") == 0 ||
\r
763 rom_strcmp(0xfe, "WISEGAME 11-03-1993") == 0 || // Funny World
\r
764 rom_strcmp(0x95, "MALLET LEGEND ") == 0)) // Whac-A-Critter
\r
766 carthw_realtec_startup();
\r
770 else if (name_cmp("KID CHAMELEON") == 0 && Pico.romsize > 0x100000)
\r
772 carthw_radica_startup();
\r
775 // Some games malfunction if SRAM is not filled with 0xff
\r
776 if (name_cmp("DINO DINI'S SOCCER") == 0 ||
\r
777 name_cmp("MICRO MACHINES II") == 0)
\r
779 memset(SRam.data, 0xff, sram_size);
\r
782 // Unusual region 'code'
\r
783 if (rom_strcmp(0x1f0, "EUROPE") == 0 || rom_strcmp(0x1f0, "Europe") == 0)
\r
784 *(int *) (Pico.rom+0x1f0) = 0x20204520;
\r