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 char *rom_exts[] = { "bin", "gen", "smd", "iso" };
\r
18 void (*PicoCartUnloadHook)(void) = NULL;
\r
20 void (*PicoCartLoadProgressCB)(int percent) = NULL;
\r
21 void (*PicoCDLoadProgressCB)(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 pm_file *pm_open(const char *path)
\r
76 pm_file *file = NULL;
\r
80 if (path == NULL) return NULL;
\r
82 if (strlen(path) < 5) ext = NULL; // no ext
\r
83 else ext = path + strlen(path) - 3;
\r
85 if (ext && strcasecmp(ext, "zip") == 0)
\r
87 struct zipent *zipentry;
\r
92 zipfile = openzip(path);
\r
94 if (zipfile != NULL)
\r
96 /* search for suitable file (right extension or large enough file) */
\r
97 while ((zipentry = readzip(zipfile)) != NULL)
\r
99 if (zipentry->uncompressed_size >= 128*1024) goto found_rom_zip;
\r
100 if (strlen(zipentry->name) < 5) continue;
\r
102 ext = zipentry->name+strlen(zipentry->name)-3;
\r
103 for (i = 0; i < sizeof(rom_exts)/sizeof(rom_exts[0]); i++)
\r
104 if (strcasecmp(ext, rom_exts[i]) == 0) goto found_rom_zip;
\r
107 /* zipfile given, but nothing found suitable for us inside */
\r
111 /* try to convert to gzip stream, so we could use standard gzio functions from zlib */
\r
112 gzf = zip2gz(zipfile, zipentry);
\r
113 if (gzf == NULL) goto zip_failed;
\r
115 file = malloc(sizeof(*file));
\r
116 if (file == NULL) goto zip_failed;
\r
117 file->file = zipfile;
\r
119 file->size = zipentry->uncompressed_size;
\r
120 file->type = PMT_ZIP;
\r
126 zipfile->fp = NULL; // gzclose() closed it
\r
132 else if (ext && strcasecmp(ext, "cso") == 0)
\r
134 cso_struct *cso = NULL, *tmp = NULL;
\r
136 f = fopen(path, "rb");
\r
141 /* we use our own buffering */
\r
142 setvbuf(f, NULL, _IONBF, 0);
\r
145 cso = malloc(sizeof(*cso));
\r
149 if (fread(&cso->header, 1, sizeof(cso->header), f) != sizeof(cso->header))
\r
152 if (strncmp(cso->header.magic, "CISO", 4) != 0) {
\r
153 elprintf(EL_STATUS, "cso: bad header");
\r
157 if (cso->header.block_size != 2048) {
\r
158 elprintf(EL_STATUS, "cso: bad block size (%u)", cso->header.block_size);
\r
162 size = ((cso->header.total_bytes >> 11) + 1)*4 + sizeof(*cso);
\r
163 tmp = realloc(cso, size);
\r
167 elprintf(EL_STATUS, "allocated %i bytes for CSO struct", size);
\r
169 size -= sizeof(*cso); // index size
\r
170 if (fread(cso->index, 1, size, f) != size) {
\r
171 elprintf(EL_STATUS, "cso: premature EOF");
\r
176 cso->fpos_in = ftell(f);
\r
178 cso->block_in_buff = -1;
\r
179 file = malloc(sizeof(*file));
\r
180 if (file == NULL) goto cso_failed;
\r
183 file->size = cso->header.total_bytes;
\r
184 file->type = PMT_CSO;
\r
188 if (cso != NULL) free(cso);
\r
189 if (f != NULL) fclose(f);
\r
193 /* not a zip, treat as uncompressed file */
\r
194 f = fopen(path, "rb");
\r
195 if (f == NULL) return NULL;
\r
197 file = malloc(sizeof(*file));
\r
198 if (file == NULL) {
\r
202 fseek(f, 0, SEEK_END);
\r
204 file->param = NULL;
\r
205 file->size = ftell(f);
\r
206 file->type = PMT_UNCOMPRESSED;
\r
207 fseek(f, 0, SEEK_SET);
\r
209 #ifndef __EPOC32__ // makes things worse on Symbian
\r
210 if (file->size > 0x400000)
\r
211 /* we use our own buffering */
\r
212 setvbuf(f, NULL, _IONBF, 0);
\r
218 size_t pm_read(void *ptr, size_t bytes, pm_file *stream)
\r
222 if (stream->type == PMT_UNCOMPRESSED)
\r
224 ret = fread(ptr, 1, bytes, stream->file);
\r
226 else if (stream->type == PMT_ZIP)
\r
228 gzFile gf = stream->param;
\r
230 ret = gzread(gf, ptr, bytes);
\r
231 err = gzerror2(gf);
\r
232 if (ret > 0 && (err == Z_DATA_ERROR || err == Z_STREAM_END))
\r
233 /* we must reset stream pointer or else next seek/read fails */
\r
236 else if (stream->type == PMT_CSO)
\r
238 cso_struct *cso = stream->param;
\r
239 int read_pos, read_len, out_offs, rret;
\r
240 int block = cso->fpos_out >> 11;
\r
241 int index = cso->index[block];
\r
242 int index_end = cso->index[block+1];
\r
243 unsigned char *out = ptr, *tmp_dst;
\r
248 out_offs = cso->fpos_out&0x7ff;
\r
249 if (out_offs == 0 && bytes >= 2048)
\r
251 else tmp_dst = cso->out_buff;
\r
253 read_pos = (index&0x7fffffff) << cso->header.align;
\r
256 if (read_pos != cso->fpos_in)
\r
257 fseek(stream->file, read_pos, SEEK_SET);
\r
258 rret = fread(tmp_dst, 1, 2048, stream->file);
\r
259 cso->fpos_in = read_pos + rret;
\r
260 if (rret != 2048) break;
\r
262 read_len = (((index_end&0x7fffffff) << cso->header.align) - read_pos) & 0xfff;
\r
263 if (block != cso->block_in_buff)
\r
265 if (read_pos != cso->fpos_in)
\r
266 fseek(stream->file, read_pos, SEEK_SET);
\r
267 rret = fread(cso->in_buff, 1, read_len, stream->file);
\r
268 cso->fpos_in = read_pos + rret;
\r
269 if (rret != read_len) {
\r
270 elprintf(EL_STATUS, "cso: read failed @ %08x", read_pos);
\r
273 cso->block_in_buff = block;
\r
275 rret = uncompress2(tmp_dst, 2048, cso->in_buff, read_len);
\r
277 elprintf(EL_STATUS, "cso: uncompress failed @ %08x with %i", read_pos, rret);
\r
283 if (out_offs != 0 || bytes < 2048) {
\r
284 //elprintf(EL_STATUS, "cso: unaligned/nonfull @ %08x, offs=%i, len=%u", cso->fpos_out, out_offs, bytes);
\r
285 if (bytes < rret) rret = bytes;
\r
286 if (2048 - out_offs < rret) rret = 2048 - out_offs;
\r
287 memcpy(out, tmp_dst + out_offs, rret);
\r
291 cso->fpos_out += rret;
\r
295 index_end = cso->index[block+1];
\r
304 int pm_seek(pm_file *stream, long offset, int whence)
\r
306 if (stream->type == PMT_UNCOMPRESSED)
\r
308 fseek(stream->file, offset, whence);
\r
309 return ftell(stream->file);
\r
311 else if (stream->type == PMT_ZIP)
\r
313 if (PicoMessage != NULL && offset > 6*1024*1024) {
\r
314 long pos = gztell((gzFile) stream->param);
\r
315 if (offset < pos || offset - pos > 6*1024*1024)
\r
316 PicoMessage("Decompressing data...");
\r
318 return gzseek((gzFile) stream->param, offset, whence);
\r
320 else if (stream->type == PMT_CSO)
\r
322 cso_struct *cso = stream->param;
\r
325 case SEEK_CUR: cso->fpos_out += offset; break;
\r
326 case SEEK_SET: cso->fpos_out = offset; break;
\r
327 case SEEK_END: cso->fpos_out = cso->header.total_bytes - offset; break;
\r
329 return cso->fpos_out;
\r
335 int pm_close(pm_file *fp)
\r
339 if (fp == NULL) return EOF;
\r
341 if (fp->type == PMT_UNCOMPRESSED)
\r
345 else if (fp->type == PMT_ZIP)
\r
347 ZIP *zipfile = fp->file;
\r
348 gzclose((gzFile) fp->param);
\r
349 zipfile->fp = NULL; // gzclose() closed it
\r
352 else if (fp->type == PMT_CSO)
\r
365 void Byteswap(unsigned char *data,int len)
\r
369 if (len<2) return; // Too short
\r
373 unsigned short *pd=(unsigned short *)(data+i);
\r
374 int value=*pd; // Get 2 bytes
\r
376 value=(value<<8)|(value>>8); // Byteswap it
\r
377 *pd=(unsigned short)value; // Put 2b ytes
\r
383 // Interleve a 16k block and byteswap
\r
384 static int InterleveBlock(unsigned char *dest,unsigned char *src)
\r
387 for (i=0;i<0x2000;i++) dest[(i<<1) ]=src[ i]; // Odd
\r
388 for (i=0;i<0x2000;i++) dest[(i<<1)+1]=src[0x2000+i]; // Even
\r
392 // Decode a SMD file
\r
393 static int DecodeSmd(unsigned char *data,int len)
\r
395 unsigned char *temp=NULL;
\r
398 temp=(unsigned char *)malloc(0x4000);
\r
399 if (temp==NULL) return 1;
\r
400 memset(temp,0,0x4000);
\r
402 // Interleve each 16k block and shift down by 0x200:
\r
403 for (i=0; i+0x4200<=len; i+=0x4000)
\r
405 InterleveBlock(temp,data+0x200+i); // Interleve 16k to temporary buffer
\r
406 memcpy(data+i,temp,0x4000); // Copy back in
\r
413 static unsigned char *cd_realloc(void *old, int filesize)
\r
415 unsigned char *rom;
\r
416 rom=realloc(old, sizeof(mcd_state));
\r
417 if (rom) memset(rom+0x20000, 0, sizeof(mcd_state)-0x20000);
\r
421 static unsigned char *PicoCartAlloc(int filesize)
\r
424 unsigned char *rom;
\r
426 if (PicoAHW & PAHW_MCD) return cd_realloc(NULL, filesize);
\r
428 alloc_size=filesize+0x7ffff;
\r
429 if((filesize&0x3fff)==0x200) alloc_size-=0x200;
\r
430 alloc_size&=~0x7ffff; // use alloc size of multiples of 512K, so that memhandlers could be set up more efficiently
\r
431 if((filesize&0x3fff)==0x200) alloc_size+=0x200;
\r
432 else if(alloc_size-filesize < 4) alloc_size+=4; // padding for out-of-bound exec protection
\r
434 // Allocate space for the rom plus padding
\r
435 rom=(unsigned char *)malloc(alloc_size);
\r
436 if(rom) memset(rom+alloc_size-0x80000,0,0x80000);
\r
440 int PicoCartLoad(pm_file *f,unsigned char **prom,unsigned int *psize)
\r
442 unsigned char *rom=NULL; int size, bytes_read;
\r
443 if (f==NULL) return 1;
\r
446 if (size <= 0) return 1;
\r
447 size=(size+3)&~3; // Round up to a multiple of 4
\r
449 // Allocate space for the rom plus padding
\r
450 rom=PicoCartAlloc(size);
\r
452 elprintf(EL_STATUS, "out of memory (wanted %i)", size);
\r
456 if (PicoCartLoadProgressCB != NULL)
\r
458 // read ROM in blocks, just for fun
\r
460 unsigned char *p = rom;
\r
464 int todo = size - bytes_read;
\r
465 if (todo > 256*1024) todo = 256*1024;
\r
466 ret = pm_read(p,todo,f);
\r
469 PicoCartLoadProgressCB(bytes_read * 100 / size);
\r
474 bytes_read = pm_read(rom,size,f); // Load up the rom
\r
475 if (bytes_read <= 0) {
\r
476 elprintf(EL_STATUS, "read failed");
\r
481 // maybe we are loading MegaCD BIOS?
\r
482 if (!(PicoAHW & PAHW_MCD) && size == 0x20000 && (!strncmp((char *)rom+0x124, "BOOT", 4) ||
\r
483 !strncmp((char *)rom+0x128, "BOOT", 4))) {
\r
484 PicoAHW |= PAHW_MCD;
\r
485 rom = cd_realloc(rom, size);
\r
489 if (size >= 0x4200 && (size&0x3fff)==0x200 &&
\r
490 ((rom[0x2280] == 'S' && rom[0x280] == 'E') || (rom[0x280] == 'S' && rom[0x2281] == 'E'))) {
\r
491 DecodeSmd(rom,size); size-=0x200; // Decode and byteswap SMD
\r
493 else Byteswap(rom,size); // Just byteswap
\r
495 if (prom) *prom=rom;
\r
496 if (psize) *psize=size;
\r
501 // Insert a cartridge:
\r
502 int PicoCartInsert(unsigned char *rom,unsigned int romsize)
\r
504 // notaz: add a 68k "jump one op back" opcode to the end of ROM.
\r
505 // This will hang the emu, but will prevent nasty crashes.
\r
506 // note: 4 bytes are padded to every ROM
\r
508 *(unsigned long *)(rom+romsize) = 0xFFFE4EFA; // 4EFA FFFE byteswapped
\r
511 Pico.romsize=romsize;
\r
518 if (PicoCartUnloadHook != NULL) {
\r
519 PicoCartUnloadHook();
\r
520 PicoCartUnloadHook = NULL;
\r
523 PicoAHW &= PAHW_MCD;
\r
525 PicoMemResetHooks();
\r
526 PicoDmaHook = NULL;
\r
527 PicoResetHook = NULL;
\r
528 PicoLineHook = NULL;
\r
529 PicoLoadStateHook = NULL;
\r
530 carthw_chunks = NULL;
\r
534 if (!(PicoAHW & PAHW_MCD))
\r
537 // setup correct memory map for loaded ROM
\r
538 // call PicoMemReset again due to possible memmap change
\r
541 elprintf(EL_STATUS|EL_ANOMALY, "starting in unknown hw configuration: %x", PicoAHW);
\r
543 case PAHW_SVP: PicoMemSetup(); break;
\r
544 case PAHW_MCD: PicoMemSetupCD(); break;
\r
545 case PAHW_PICO: PicoMemSetupPico(); break;
\r
553 void PicoCartUnload(void)
\r
555 if (Pico.rom != NULL) {
\r
556 SekFinishIdleDet();
\r
562 static int rom_strcmp(int rom_offset, const char *s1)
\r
564 int i, len = strlen(s1);
\r
565 const char *s_rom = (const char *)Pico.rom + rom_offset;
\r
566 for (i = 0; i < len; i++)
\r
567 if (s1[i] != s_rom[i^1])
\r
572 static int name_cmp(const char *name)
\r
574 return rom_strcmp(0x150, name);
\r
578 * various cart-specific things, which can't be handled by generic code
\r
579 * (maybe I should start using CRC for this stuff?)
\r
581 static void PicoCartDetect(void)
\r
583 int sram_size = 0, csum;
\r
584 Pico.m.sram_reg = 0;
\r
586 csum = PicoRead32(0x18c) & 0xffff;
\r
588 if (Pico.rom[0x1B1] == 'R' && Pico.rom[0x1B0] == 'A')
\r
590 if (Pico.rom[0x1B2] & 0x40)
\r
593 SRam.start = PicoRead32(0x1B4) & ~1; // zero address is used for clock by some games
\r
594 SRam.end = PicoRead32(0x1B8);
\r
595 sram_size = 0x2000;
\r
596 Pico.m.sram_reg |= 4;
\r
599 SRam.start = PicoRead32(0x1B4) & ~0xff;
\r
600 SRam.end = PicoRead32(0x1B8) | 1;
\r
601 sram_size = SRam.end - SRam.start + 1;
\r
603 SRam.start &= ~0xff000000;
\r
604 SRam.end &= ~0xff000000;
\r
605 Pico.m.sram_reg |= 0x10; // SRAM was detected
\r
607 if (sram_size <= 0)
\r
609 // some games may have bad headers, like S&K and Sonic3
\r
610 // note: majority games use 0x200000 as starting address, but there are some which
\r
611 // use something else (0x300000 by HardBall '95). Luckily they have good headers.
\r
612 SRam.start = 0x200000;
\r
613 SRam.end = 0x203FFF;
\r
614 sram_size = 0x004000;
\r
617 // this game actually doesn't have SRAM, but some weird protection
\r
618 if (rom_strcmp(0x120, "PUGGSY") == 0)
\r
620 SRam.start = SRam.end = sram_size = 0;
\r
625 SRam.data = (unsigned char *) calloc(sram_size, 1);
\r
626 if (SRam.data == NULL) return;
\r
630 // set EEPROM defaults, in case it gets detected
\r
631 SRam.eeprom_type = 0; // 7bit (24C01)
\r
632 SRam.eeprom_abits = 3; // eeprom access must be odd addr for: bit0 ~ cl, bit1 ~ in
\r
633 SRam.eeprom_bit_cl = 1;
\r
634 SRam.eeprom_bit_in = 0;
\r
635 SRam.eeprom_bit_out= 0;
\r
637 // some known EEPROM data (thanks to EkeEke)
\r
638 if (name_cmp("COLLEGE SLAM") == 0 ||
\r
639 name_cmp("FRANK THOMAS BIGHURT BASEBAL") == 0)
\r
641 SRam.eeprom_type = 3;
\r
642 SRam.eeprom_abits = 2;
\r
643 SRam.eeprom_bit_cl = 0;
\r
645 else if (name_cmp("NBA JAM TOURNAMENT EDITION") == 0 ||
\r
646 name_cmp("NFL QUARTERBACK CLUB") == 0)
\r
648 SRam.eeprom_type = 2;
\r
649 SRam.eeprom_abits = 2;
\r
650 SRam.eeprom_bit_cl = 0;
\r
652 else if (name_cmp("NBA JAM") == 0)
\r
654 SRam.eeprom_type = 2;
\r
655 SRam.eeprom_bit_out = 1;
\r
656 SRam.eeprom_abits = 0;
\r
658 else if (name_cmp("NHLPA HOCKEY '93") == 0 ||
\r
659 name_cmp("NHLPA Hockey '93") == 0 ||
\r
660 name_cmp("RINGS OF POWER") == 0)
\r
662 SRam.start = SRam.end = 0x200000;
\r
663 Pico.m.sram_reg = 0x14;
\r
664 SRam.eeprom_abits = 0;
\r
665 SRam.eeprom_bit_cl = 6;
\r
666 SRam.eeprom_bit_in = 7;
\r
667 SRam.eeprom_bit_out= 7;
\r
669 else if ( name_cmp("MICRO MACHINES II") == 0 ||
\r
670 (name_cmp(" ") == 0 && // Micro Machines {Turbo Tournament '96, Military - It's a Blast!}
\r
671 (csum == 0x165e || csum == 0x168b || csum == 0xCEE0 || csum == 0x2C41)))
\r
673 SRam.start = 0x300000;
\r
674 SRam.end = 0x380001;
\r
675 Pico.m.sram_reg = 0x14;
\r
676 SRam.eeprom_type = 2;
\r
677 SRam.eeprom_abits = 0;
\r
678 SRam.eeprom_bit_cl = 1;
\r
679 SRam.eeprom_bit_in = 0;
\r
680 SRam.eeprom_bit_out= 7;
\r
684 else if (name_cmp("Virtua Racing") == 0 ||
\r
685 name_cmp("VIRTUA RACING") == 0)
\r
691 else if (rom_strcmp(0x100, "SEGA PICO") == 0 ||
\r
692 rom_strcmp(0x100, "IMA IKUNOUJYUKU") == 0) // what is that supposed to mean?
\r
697 // Detect 12-in-1 mapper
\r
698 else if ((name_cmp("ROBOCOP 3") == 0 && Pico.romsize == 0x200000) ||
\r
699 (rom_strcmp(0x160, "FLICKY") == 0 && Pico.romsize >= 0x200000) ||
\r
700 (name_cmp(" SHOVE IT!") == 0 && Pico.romsize >= 0x200000) ||
\r
701 (name_cmp("MS PACMAN") == 0 && Pico.romsize >= 0x200000) || // bad dump?
\r
702 (name_cmp("ALIEN 3") == 0 && Pico.romsize == 0x200000))
\r
704 carthw_12in1_startup();
\r
708 else if (Pico.romsize == 512*1024 && (
\r
709 rom_strcmp(0x94, "THE EARTH DEFEND") == 0 ||
\r
710 rom_strcmp(0xfe, "WISEGAME 11-03-1993") == 0 || // Funny World
\r
711 rom_strcmp(0x95, "MALLET LEGEND ") == 0)) // Whac-A-Critter
\r
713 carthw_realtec_startup();
\r
717 else if (name_cmp("KID CHAMELEON") == 0 && Pico.romsize > 0x100000)
\r
719 carthw_radica_startup();
\r
722 // Some games malfunction if SRAM is not filled with 0xff
\r
723 if (name_cmp("DINO DINI'S SOCCER") == 0 ||
\r
724 name_cmp("MICRO MACHINES II") == 0)
\r
726 memset(SRam.data, 0xff, sram_size);
\r
729 // Unusual region 'code'
\r
730 if (rom_strcmp(0x1f0, "EUROPE") == 0 || rom_strcmp(0x1f0, "Europe") == 0)
\r
731 *(int *) (Pico.rom+0x1f0) = 0x20204520;
\r