1 /* Decode a Game Genie code into an M68000 address/data pair.
2 * The Game Genie code is made of the characters
3 * ABCDEFGHJKLMNPRSTVWXYZ0123456789 (notice the missing I, O, Q and U).
4 * Where A = 00000, B = 00001, C = 00010, ... , on to 9 = 11111.
6 * These come out to a very scrambled bit pattern like this:
7 * (SCRA-MBLE is just an example)
10 * 01111 00010 01110 00000 01011 00001 01010 00100
11 * ijklm nopIJ KLMNO PABCD EFGHd efgha bcQRS TUVWX
13 * Our goal is to rearrange that to this:
15 * 0000 0101 1001 1100 0100 0100 : 1011 0000 0111 1000
16 * ABCD EFGH IJKL MNOP QRST UVWX : abcd efgh ijkl mnop
18 * which in Hexadecimal is 059C44:B078. Simple, huh? ;)
20 * So, then, we dutifully change memory location 059C44 to B078!
21 * (of course, that's handled by a different source file :)
35 struct patch_inst *PicoPatches = NULL;
36 int PicoPatchCount = 0;
38 static char genie_chars_md[] = "AaBbCcDdEeFfGgHhJjKkLlMmNnPpRrSsTtVvWwXxYyZz0O1I2233445566778899";
41 * This function converts a Game Genie code to an address:data pair.
42 * The code is given as an 8-character string, like "BJX0SA1C". It need not
43 * be null terminated, since only the first 8 characters are taken. It is
44 * assumed that the code is already made of valid characters, i.e. there are no
45 * Q's, U's, or symbols. If such a character is
46 * encountered, the function will return with a warning on stderr.
48 * The resulting address:data pair is returned in the struct patch pointed to
49 * by result. If an error results, both the address and data will be set to -1.
52 static void genie_decode_md(const char* code, struct patch* result)
59 /* Skip i=4; it's going to be the separating hyphen */
62 /* If strchr returns NULL, we were given a bad character */
63 if(!(x = strchr(genie_chars_md, code[i])))
65 result->addr = -1; result->data = -1;
68 n = (x - genie_chars_md) >> 1;
69 /* Now, based on which character this is, fit it into the result */
73 /* ____ ____ ____ ____ ____ ____ : ____ ____ ABCD E___ */
74 result->data |= n << 3;
77 /* ____ ____ DE__ ____ ____ ____ : ____ ____ ____ _ABC */
78 result->data |= n >> 2;
79 result->addr |= (n & 3) << 14;
82 /* ____ ____ __AB CDE_ ____ ____ : ____ ____ ____ ____ */
83 result->addr |= n << 9;
86 /* BCDE ____ ____ ___A ____ ____ : ____ ____ ____ ____ */
87 result->addr |= (n & 0xF) << 20 | (n >> 4) << 8;
90 /* ____ ABCD ____ ____ ____ ____ : ___E ____ ____ ____ */
91 result->data |= (n & 1) << 12;
92 result->addr |= (n >> 1) << 16;
95 /* ____ ____ ____ ____ ____ ____ : E___ ABCD ____ ____ */
96 result->data |= (n & 1) << 15 | (n >> 1) << 8;
99 /* ____ ____ ____ ____ CDE_ ____ : _AB_ ____ ____ ____ */
100 result->data |= (n >> 3) << 13;
101 result->addr |= (n & 7) << 5;
104 /* ____ ____ ____ ____ ___A BCDE : ____ ____ ____ ____ */
108 /* Go around again */
113 /* "Decode" an address/data pair into a structure. This is for "012345:ABCD"
114 * type codes. You're more likely to find Genie codes circulating around, but
115 * there's a chance you could come on to one of these. Which is nice, since
116 * they're MUCH easier to implement ;) Once again, the input should be depunc-
119 static char hex_chars[] = "00112233445566778899AaBbCcDdEeFf";
121 static void hex_decode_md(const char *code, struct patch *result)
125 /* 6 digits for address */
126 for(i = 0; i < 6; ++i)
128 if(!(x = strchr(hex_chars, code[i])))
130 result->addr = result->data = -1;
133 result->addr = (result->addr << 4) | ((x - hex_chars) >> 1);
135 /* 4 digits for data */
136 for(i = 7; i < 11; ++i)
138 if(!(x = strchr(hex_chars, code[i])))
141 result->addr = result->data = -1;
144 result->data = (result->data << 4) | ((x - hex_chars) >> 1);
148 void genie_decode_ms(const char *code, struct patch *result)
152 /* 2 digits for data */
155 if(!(x = strchr(hex_chars, code[i])))
157 result->addr = result->data = -1;
160 result->data = (result->data << 4) | ((x - hex_chars) >> 1);
162 /* 4 digits for address */
165 /* 4th character is hyphen and can be skipped*/
167 if(!(x = strchr(hex_chars, code[i])))
169 result->addr = result->data = -1;
172 result->addr = (result->addr << 4) | ((x - hex_chars) >> 1);
174 /* Correct the address */
175 result->addr = ((result->addr >> 4) | (result->addr << 12 & 0xF000)) ^ 0xF000;
176 /* Optional: 3 digits for comp */
180 if (i==9) continue; /* 2nd character is ignored */
181 if(!(x = strchr(hex_chars, code[i])))
183 result->addr = result->data = -1;
186 result->comp = (result->comp << 4) | ((x - hex_chars) >> 1);
188 /* Correct the comp */
189 result->comp = ((result->comp >> 2) | ((result->comp << 6) & 0xC0)) ^ 0xBA;
193 void ar_decode_ms(const char *code, struct patch *result){
196 /* 2 digits of padding*/
197 /* 4 digits for address */
200 /* 5th character is hyphen and can be skipped*/
202 if(!(x = strchr(hex_chars, code[i])))
204 result->addr = result->data = -1;
207 result->addr = (result->addr << 4) | ((x - hex_chars) >> 1);
209 /* 2 digits for data */
212 if(!(x = strchr(hex_chars, code[i])))
214 result->addr = result->data = -1;
217 result->data = (result->data << 4) | ((x - hex_chars) >> 1);
221 void fusion_ram_decode(const char *code, struct patch *result){
224 /* 4 digits for address */
227 if(!(x = strchr(hex_chars, code[i])))
229 result->addr = result->data = -1;
232 result->addr = (result->addr << 4) | ((x - hex_chars) >> 1);
235 /* 2 digits for data */
238 if(!(x = strchr(hex_chars, code[i])))
240 result->addr = result->data = -1;
243 result->data = (result->data << 4) | ((x - hex_chars) >> 1);
247 void fusion_rom_decode(const char *code, struct patch *result){
250 /* 2 digits for comp */
253 if(!(x = strchr(hex_chars, code[i])))
255 result->addr = result->data = -1;
258 result->comp = (result->comp << 4) | ((x - hex_chars) >> 1);
260 /* 4 digits for address */
263 if(!(x = strchr(hex_chars, code[i])))
265 result->addr = result->data = -1;
268 result->addr = (result->addr << 4) | ((x - hex_chars) >> 1);
270 /* 2 digits for data */
273 if(!(x = strchr(hex_chars, code[i])))
275 result->addr = result->data = -1;
278 result->data = (result->data << 4) | ((x - hex_chars) >> 1);
282 /* THIS is the function you call from the MegaDrive or whatever. This figures
283 * out whether it's a genie or hex code, depunctuates it, and calls the proper
285 void decode(const char* code, struct patch* result)
287 int len = strlen(code);
289 /* Initialize the result */
290 result->addr = result->data = result->comp = 0;
292 if(!(PicoAHW & PAHW_SMS))
297 if(len == 9 && code[4] == '-')
299 genie_decode_md(code, result);
304 else if(len >=9 && code[6] == ':')
306 hex_decode_md(code, result);
317 if(len == 11 && code[3] == '-' && code[7] == '-')
319 genie_decode_ms(code, result);
323 else if(len == 9 && code[4] == '-')
325 ar_decode_ms(code, result);
329 else if(len == 7 && code[4] == ':')
331 fusion_ram_decode(code, result);
335 else if(len == 9 && code[6] == ':')
337 fusion_rom_decode(code, result);
345 //Convert RAM address space to Genesis location.
346 if (result->addr>=0xC000)
347 result->addr= 0xFF0000 | (0x1FFF & result->addr);
353 result->data = result->addr = -1;
357 void PicoPatchUnload(void)
359 if (PicoPatches != NULL)
367 int PicoPatchLoad(const char *fname)
376 f = fopen(fname, "r");
382 while (fgets(buff, sizeof(buff), f))
387 for (clen = 0; clen < llen; clen++)
388 if (isspace_(buff[clen]))
392 if (clen > 11 || clen < 8)
396 if (pt.addr == (unsigned int)-1 || pt.data == (unsigned short)-1)
399 /* code was good, add it */
400 if (array_len < PicoPatchCount + 1)
405 ptr = realloc(PicoPatches, array_len * sizeof(PicoPatches[0]));
406 if (ptr == NULL) break;
409 strcpy(PicoPatches[PicoPatchCount].code, buff);
411 for (clen++; clen < llen; clen++)
412 if (!isspace_(buff[clen]))
414 for (llen--; llen > 0; llen--)
415 if (!isspace_(buff[llen]))
418 strncpy(PicoPatches[PicoPatchCount].name, buff + clen, 51);
419 PicoPatches[PicoPatchCount].name[51] = 0;
420 PicoPatches[PicoPatchCount].active = 0;
421 PicoPatches[PicoPatchCount].addr = pt.addr;
422 PicoPatches[PicoPatchCount].data = pt.data;
423 PicoPatches[PicoPatchCount].data_old = 0;
425 // fprintf(stderr, "loaded patch #%i: %06x:%04x \"%s\"\n", PicoPatchCount-1, pt.addr, pt.data,
426 // PicoPatches[PicoPatchCount-1].name);
433 /* to be called when the Rom is loaded and byteswapped */
434 void PicoPatchPrepare(void)
439 for (i = 0; i < PicoPatchCount; i++)
441 addr=PicoPatches[i].addr;
443 if (addr < Pico.romsize)
444 PicoPatches[i].data_old = *(unsigned short *)(Pico.rom + addr);
447 if(!(PicoAHW & PAHW_SMS))
448 PicoPatches[i].data_old = (unsigned short) m68k_read16(addr);
450 ; // wrong: PicoPatches[i].data_old = (unsigned char) PicoRead8_z80(addr);
452 if (strstr(PicoPatches[i].name, "AUTO"))
453 PicoPatches[i].active = 1;
457 void PicoPatchApply(void)
462 for (i = 0; i < PicoPatchCount; i++)
464 addr = PicoPatches[i].addr;
466 if (addr < Pico.romsize)
468 if (PicoPatches[i].active)
470 if (!(PicoAHW & PAHW_SMS))
471 *(unsigned short *)(Pico.rom + addr) = PicoPatches[i].data;
472 else if (!PicoPatches[i].comp || PicoPatches[i].comp == *(char *)(Pico.rom + addr))
473 *(char *)(Pico.rom + addr) = (char) PicoPatches[i].data;
477 // if current addr is not patched by older patch, write back original val
478 for (u = 0; u < i; u++)
479 if (PicoPatches[u].addr == addr) break;
482 if (!(PicoAHW & PAHW_SMS))
483 *(unsigned short *)(Pico.rom + addr) = PicoPatches[i].data_old;
485 *(char *)(Pico.rom + addr) = (char) PicoPatches[i].data_old;
488 // fprintf(stderr, "patched %i: %06x:%04x\n", PicoPatches[i].active, addr,
489 // *(unsigned short *)(Pico.rom + addr));
493 if (PicoPatches[i].active)
495 if (!(PicoAHW & PAHW_SMS))
496 m68k_write16(addr,PicoPatches[i].data);
498 ;// wrong: PicoWrite8_z80(addr,PicoPatches[i].data);
502 // if current addr is not patched by older patch, write back original val
503 for (u = 0; u < i; u++)
504 if (PicoPatches[u].addr == addr) break;
507 if (!(PicoAHW & PAHW_SMS))
508 m68k_write16(PicoPatches[i].addr,PicoPatches[i].data_old);
510 ;// wrong: PicoWrite8_z80(PicoPatches[i].addr,PicoPatches[i].data_old);